Welcome to the REST API reference for TitanFile. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. All requests occur over HTTPS and our API is protected by TitanFile security as described here.
\nThe TitanFile API offers the following methods of authentication:
\nJWT Authentication (With API Keys)
\nOAuth 2.0
\nPlease see the corresponding authentication endpoints for more details.
\nMany objects allow you to request additional information as an expanded response by using the expand request parameter. In many cases, an object contains the ID of a related object in its response properties. For example, a ChannelContact may have an associated Channel ID. Those objects can be expanded inline with the expand request parameter. ID fields that can be expanded into objects are noted in this documentation with theexpandable label.
This parameter is available on all API requests with the exception of endpoints that return paginated responses (e.g. list channel files), and applies to the response of that request only.
\nIf your account has the correct permissions for you to delegate or impersonate as another subscription member, you may do so by including the request parameter actor (the ID of the user) or actor_email (the user's email address). This parameter is available on all API requests, and applies to the response of that request only.
TitanFile uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success. Codes in the 4xx range indicate an error occured due to the information provided (e.g. a required parameter was omitted, an object with the given ID does not exist, a user does not have permission to access a certain file, etc.). Codes in the 5xx range indicate an error with TitanFile’s servers.
type (string)
The type of error returned.
param (string)
If the error is parameter-specific, the parameter related to the error.
message (string)
A human-readable message providing more details about the error.
code (string)
For some errors that could be handled programmatically, a short string indicating the error code reported. E.g. authentication_failed, not_found,permission_denied.
We are currently on version 1.0 of the API. The version must be specified as part of the media type in the Accept header. For example:
Accept: application/json; version=1.0
The API ID.
\n","type":"text"},{"key":"password","value":"{{api_key}}","description":"The API key.
\n","type":"text"}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/token/","description":"Generate a JWT using your API ID and API key as the username and password respectively. The access token returned may be used in the authorization header for subsequent requests (i.e. Authorization: Bearer {access_token}).
When an access token expires, you will receive a token_not_valid error code at which point you may use the refresh token to obtain a new access token. Access tokens expire in 1 hour and refresh tokens expire in 14 days.
Returns
\nAn access and refresh token.
\naccess (string)
The access token.
refresh (string)
The refresh token.
The refresh token.
\n","type":"text"}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/token/refresh/","description":"When your access token expires, you can use the longer-lived refresh token to obtain another access token.
\nReturns
\nAn access token.
\naccess (string)
The access token.
You can view and manage your API keys by logging into your account and going under Options > User Profile. Under the section API Access, click Get an API key.
\nUse your API ID and API Key to request a JWT access token via the requests provided in this folder (Generate JWT, Refresh JWT).
Once you obtain the token, include it in the Authorization header of your API requests.
(Required string) The application's client ID.
\n"},{"key":"client_secret","value":"","type":"text","description":"(Required, unless the client type is public, string) The application's client secret.
\n"},{"key":"code","value":"","type":"text","description":"(Required string) The code obtained after the user authorized access to their TitanFile account.
\n"},{"key":"code_verifier","value":"","type":"text","description":"(Required string) The initial string (before encryption) that was used to implement PKCE.
\n"},{"key":"redirect_uri","value":"","type":"text","description":"(Redirect string) The redirect URI that was used when obtaining consent from the TitanFile user.
\n"},{"key":"grant_type","value":"","type":"text","description":"(Required string) The type of OAuth 2.0 grant being used. To exchange an authorization code for an access token, use authorization_code.
The access token returned from this endpoint may be used in the authorization header for subsequent requests (i.e. Authorization: Bearer {access_token}). Access tokens expire in 1 hour and refresh tokens expire in 14 days.
Prerequisites
\nYou have created an OAuth 2.0 app. See the section titled \"Creating an OAuth 2.0 app\" under here for more details.
\nThe code value that is required for this endpoint is obtained when a user authorizes your app to access their TitanFile account. Click here for more details.
Returns
\nAn access and refresh token.
\naccess_token (string)
The access token.
expires_in (int)
Amount of time in seconds at which the access token expires.
token_type (string)
The type of token returned.
scope (string)
The scope(s) for the token.
refresh_token (string)
The refresh token that can be used to obtain a new access token.
(Required string) The application's client ID.
\n"},{"key":"client_secret","value":"","type":"text","description":"(Required, unless the client type is public, string) The application's client secret.
\n"},{"key":"grant_type","value":"","type":"text","description":"(Required string) The type of OAuth 2.0 grant being used. To refresh a token, use refresh_token.
(Required string) The refresh token provided at the time the access token was generated.
\n"}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/oauth/token/","description":"You can use a refresh token to get a new access token after the access token expires.
\nReturns
\nAn access and refresh token.
\naccess_token (string)
The access token.
expires_in (int)
Amount of time in seconds at which the access token expires.
token_type (string)
The type of token returned.
scope (string)
The scope(s) for the token.
refresh_token (string)
The refresh token that can be used to obtain a new access token.
Authorization Code Grant is an OAuth 2.0 flow used by server-hosted integrations to obtain an access token.
\nIn the Authorization Code Grant flow, your client integration will obtain consent from a TitanFile user to perform actions on their behalf. Once consent is granted, your app will receive an authorization code that can be exchanged for an access token. You can use the Authorization Code Grant to authenticate if:
\nThe users of your integration have TitanFIle accounts and will log in to your integrated application individually.
\nYour integration is hosted on a server, with clients accessing via browser interface or client-side app.
\nProof Key for Code Exchange (PKCE) is used to ensure that the app that finishes the authentication code flow is the one that started it. It does this by requiring the application to pass an additional code challenge. The exact steps to implement PKCE will be described in the next section.
\na. Generate a cryptographically random string to act as a code_verifier which will be used during step 3, when the Exchange code for token endpoint is used. Note: A new random string should be generated for every request.
b. Hash the string you generated above with the SHA256 algorithm using a standard cryptography library or tool, then base-64 URL encode it. Take note of the resulting value, this is the code_challenge.
Here is sample code in python to generate a pair of PKCE value:
\nimport random\nimport string\nimport base64\nimport hashlib\n# Generate random string.\ncode_verifier = ''.join(random.choice(string.ascii_uppercase + string.digits) for _ in range(random.randint(43, 128)))\n# Hash with SHA256. \ncode_challenge = hashlib.sha256(code_verifier.encode('utf-8')).digest()\n# Base-64 URL encode.\ncode_challenge = base64.urlsafe_b64encode(code_challenge).decode('utf-8').replace('=', '')\nprint(f'Code verifier: {code_verifier}')\nprint(f'Code challenge: {code_challenge}')\n\nBefore you can make any API calls using the Authorization Code Grant, you must get your user’s consent for your app to act on their behalf. To get this consent, you will need to direct your users to the following TitanFile URL (with the appropriate subdomain and query parameters replaced):
https://{{subdomain}}.titanfile.com/api/v1/oauth/authorize?response_type=code&scope=YOUR_REQUESTED_SCOPES&client_id=YOUR_APP_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&code_challenge=YOUR_PKCE_CODE_CHALLENGE&code_challenge_method=YOUR_PKCE_CODE_CHALLENGE_TRANSFORM_ALGORITHM\n\nQuery parameter details
\nscope: Optional space-delimited list of scopes. See the available scopes here. Default is all scopes.
client_id: Your app's client ID.
redirect_uri: The URI that TitanFile will redirect the user to once consent has been granted. This URI must match one of the URIs provided when your app was created.
code_challenge: The code_challenge from step 1b (i.e. the encrypted value).
code_challenge_method: This specifies how your PKCE code_challenge parameter was created. Though it can be plain if you did not hash your code_verifier, we never recommend using anything except S256 which uses SHA-256 hashing.
Once the user follows the URL, they will be prompted to sign in to their TitanFile account and give consent for your app to make calls on their behalf. Note: If localhost was used for testing purposes as your redirect URI, your browser may attempt to load the query parameters as a web page. This will result in a display error message, which can safely be ignored. After authorization, select the value of the code query parameter in the page URI, then save it to use in the next step.
The code obtained from step 2 can now be exchanged for an access token using the Exchange code for token endpoint. Note: There is a 1 minunte window to exchange the code for a token.
(Required string) The application's client ID.
\n"},{"key":"client_secret","value":"","type":"text","description":"(Required string) The application's client secret.
\n"},{"key":"grant_type","value":"","type":"text","description":"(Required string) The type of OAuth 2.0 grant being used. Use client_credentials for the client credentials flow.
(Optional string) Space-delimited list of scopes. See full list of scopes under the section titled \"Authentication Scopes\". Default is all scopes.
\n"}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/oauth/token/","description":"The access token returned may be used in the authorization header for subsequent requests (i.e. Authorization: Bearer {access_token}). Access tokens expire in 1 hour.
Prerequisites
\nReturns
\nAn access token.
\naccess_token (string)
The access token.
expires_in (int)
Amount of time in seconds at which the access token expires.
token_type (string)
The type of token returned.
scope (string)
The scope(s) for the token.
With the Client Credentials grant type, apps are acting on behalf of themselves and therefore don’t require user consent. If you are using the TitanFIle API for back end or machine-to-machine integrations, you can use this grant type. In order to use the grant type, your client type must be a \"secret client\" (i.e. the client must be able to securely store a secret key).
\n","_postman_id":"e5a40cdf-41f4-41b6-9129-a83eae8c0991","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0cecf354-145a-4fea-a12c-bbedd1e7b437","id":"0cecf354-145a-4fea-a12c-bbedd1e7b437","name":"Authentication","type":"folder"}}},{"name":"Revoke token","id":"2be3aedb-1836-443c-92ed-2cde99a7b491","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"","type":"text","description":"(Required string) The application's client ID.
\n"},{"key":"client_secret","value":"","type":"text","description":"(Required, unless the client type is public, string) The application's client secret.
\n"},{"key":"token","value":"","type":"text","description":"(Required string) The token you wish to revoke.
\n"},{"key":"token_type_hint","value":"","type":"text","description":"(Optional enum, default is access_token) The type of token you are revoking. Must be either access_token or refresh_token.
Revoke any access or refresh token.
\nReturns
\nThe server will respond with a 200 status code on successful revocation.
TitanFile supports OAuth 2.0 to secure your API requests. Using OAuth, your app can request access to your users' TitanFile accounts and perform actions, such as sending files, on behalf of your users.
\nTitanFile provides two methods for implementing OAuth:
\nIf you are building an integration where each user logs in individually and requires a one-time consent for the app to use their TitanFile account, you should use the Authorization Code Grant.
\nIf your app uses a browser or client, it has a browser/server architecture and should use the Authorization Code Grant.
\nIf you are using the TitanFIle API for back end or machine-to-machine integrations, you should use the Client Credentials Grant.
\nIf your app is unable to securely store a secret key, it should use the Authorization Code Grant.
\nA scope is a set of permissions for an API that the app requires in order to do its work. Each scope is typically specific to a TitanFile resource. For example, you must request the files scope to perform operations listed under the Files endpoints. Each time your app authenticates, it may request one or more scopes. All scopes will be assumed if no scope is explicitly provided.
Log in to your TitanFile account. Under Options in the left sidebar, there will be a tab called Integrations where you can create an OAuth 2.0 app.
\nAs a best practice, make sure that the application's name will help your users identify that the app is part of your service or product. If your users do not recognize the name, you risk having some users revoke consent, forcing them to grant consent again to continue using your integration.
\nWhen creating your app, you may need to specify whether your app is able to securely store a client secret. If your app is unable to securely store one, your app is considered a \"public client\" and you will be forced to use the Authorization Code Grant. Otherwise, you may choose between the Authorization Code Grant and the Client Credentials Grant. Review the section \"Choosing an OAuth Grant Type\" above to determine which grant type is right for your app.
\nA redirect URI is a URI to which TitanFile will redirect the browser after a user authorizes consent. If you are using the Authorization Code Grant, you will need to define at least one redirect URI. You may set more than one redirect URI per app.
\nIf you are using the Authorization Code Grant, you have the option to provide a link to your service's privacy policy and terms of use. They will be linked on the web page that obtains the users consent.
\nOnce you create your app, you will be provided with a client ID. Your app is identified by this client ID. If your application is able to securely store a secret key, you will also be provided a client secret. Take note of the client secret before closing the window, as you will only able to view this secret key immediately after creating it. Should you lose or compromise your client secret, you may regenerate a new pair of keys by editing the app and clicking \"Regenerate client ID and secret\".
\n","_postman_id":"7a3715b1-ade5-4185-b45b-d03f44677a10","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0cecf354-145a-4fea-a12c-bbedd1e7b437","id":"0cecf354-145a-4fea-a12c-bbedd1e7b437","name":"Authentication","type":"folder"}}}],"id":"0cecf354-145a-4fea-a12c-bbedd1e7b437","description":"Note: Basic Authentication is no longer supported. All clients must use JWT or OAuth 2.0 authentication methods.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"34705ac0-f1c7-4a6b-9e89-adf71af0be2b"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"ddea0ad0-4057-4d5d-b5a8-976076ed41bb"}}],"_postman_id":"0cecf354-145a-4fea-a12c-bbedd1e7b437"},{"name":"Channels","item":[{"name":"Retrieve a channel","id":"68c861df-a85a-4311-95db-ea4363dc899e","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channels/:id/","description":"A channel object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channels",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Optional boolean) When set to true, the response includes the channel size in bytes, calculated from the files stored in the channel. Default is false.
\n","type":"text/plain"},"key":"include_size","value":null}],"variable":[{"description":{"content":"The ID of the channel.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0e68a783-14a4-4662-8da5-3aed44690b82","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channels/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channels",":id",""],"query":[{"key":"expand","value":"owner","disabled":true},{"key":"include_size","value":null,"description":"(Optional boolean) When set to true, the response includes the channel size in bytes, calculated from the files stored in the channel. Default is false.","type":"text","disabled":true}],"variable":[{"key":"id","value":"chan_543bbfd6-efd9-41b3-9444-408e6e3798a7","description":"The ID of the channel."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Thu, 06 Jul 2023 15:36:27 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"403"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chan_543bbfd6-efd9-41b3-9444-408e6e3798a7\",\n \"date_created\": 1687964185,\n \"name\": \"My Channel\",\n \"owner\": {\n \"id\": \"usr_15d94f46-d9a8-4226-a544-3b83e3b58a8e\",\n \"email\": \"example@titanfile.com\"\n },\n \"date_expired\": 1693367940,\n \"is_expired\": false,\n \"bcc\": false,\n \"open_invitation\": true,\n \"external_folder_edit\": true,\n \"open_access\": true,\n \"safe_notification\": false,\n \"read_only\": false,\n \"requires_2fa\": false,\n \"channel_url\": \"https://app.titanfile.com/channels/vs8U4g/\"\n}"}],"_postman_id":"68c861df-a85a-4311-95db-ea4363dc899e"},{"name":"Delete a channel","id":"1f21325e-1628-4771-8ec3-9d2d6c309363","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channels/:id/","description":"An object containing the ID of the successfully deleted channel object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channels",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"45935959-7266-40ef-99a1-23d5abad71da","description":{"content":"The ID of the channel.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7ec30b1d-6bd0-4a69-b898-13d484abcd6d","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channels/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channels",":id",""],"variable":[{"key":"id","value":"chan_009313ac-f5a7-4933-80b8-cce226d8ebc1","description":"The ID of the channel."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 05 May 2023 17:52:43 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"68"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chan_009313ac-f5a7-4933-80b8-cce226d8ebc1\",\n \"deleted\": true\n}"}],"_postman_id":"1f21325e-1628-4771-8ec3-9d2d6c309363"},{"name":"Create a channel","id":"c6e131e5-d92c-4f60-a9a7-7bd491817a12","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"","description":"(Required string) Name of the channel.
\n","type":"text"},{"key":"owner_email","value":"","description":"(Optional string) Email of the user who you are creating the channel on behalf of. You must have delegation rights for this user.
\n","type":"text","disabled":true},{"key":"expiry_date","value":"","description":"(Optional timestamp) Timestamp of when this channel expires.
\n","type":"text","disabled":true},{"key":"bcc","value":"","description":"(Optional boolean) Enable BCC on this channel.
\n","type":"text","disabled":true},{"key":"open_invitation","value":"","description":"(Optional boolean) Contacts can add new contacts.
\n","type":"text","disabled":true},{"key":"external_folder_edit","value":"","description":"(Optional boolean) External contacts can add/remove folders
\n","type":"text","disabled":true},{"key":"open_access","value":"","description":"(Optional boolean) Enable open access on this channel.
\n","type":"text","disabled":true},{"key":"safe_notification","value":"","description":"(Optional boolean) Enable safe notifications on this channel.
\n","type":"text","disabled":true},{"key":"read_only","value":"","description":"(Optional boolean) Enable read only on this channel.
\n","type":"text","disabled":true},{"key":"requires_2fa","value":"","description":"(Optional boolean) Require 2FA for free guest users.
\n","type":"text","disabled":true},{"key":"password","value":"","description":"(Optional, unless enforced by subscription, string) Password that is required for external users to access the channel.
\n","type":"text","disabled":true},{"key":"custom_fields","value":"","description":"(Optional, unless required by subscription, string) A JSON string representation of a dictionary containing the channel's custom fields as the key-value pair. E.g. if you want to set the custom field \"Matter\" with the value \"M01\", you would use the JSON string {\"Matter\": \"M01\"}.
The channel options available for you to set will depend on your subscription. If a channel option is available for you to set and you do not provide a value for it, the option's value will be determined based on your subscription's configuration settings.
\nA channel object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channels",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[]}},"response":[{"id":"7a80d741-3b2f-4984-8216-f73ed29ce1c5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"My Channel","description":"(Required) Name of the channel.","type":"text"},{"key":"owner","value":"example@titanfile.com","description":"(Optional) Email of the user who you are creating the channel on behalf of. You must have delegation rights for this user.","type":"text"},{"key":"date_expired","value":"1683409907","description":"(Optional) Timestamp of when this channel expires.","type":"text"},{"key":"bcc","value":"false","description":"(Optional) Enable BCC on this channel.","type":"text"},{"key":"open_invitation","value":"false","description":"(Optional) Contacts can add new contacts.","type":"text"},{"key":"external_folder_edit","value":"false","description":"(Optional) External contacts can add/remove folders","type":"text"},{"key":"open_access","value":"false","description":"(Optional) Enable open access on this channel.","type":"text"},{"key":"safe_notification","value":"false","description":"(Optional) Enable safe notifications on this channel.","type":"text"},{"key":"read_only","value":"false","description":"(Optional) Enable read only on this channel.","type":"text"},{"key":"requires_2fa","value":"true","description":"(Optional) Require 2FA for free guest users.","type":"text"}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/channels/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Thu, 06 Jul 2023 16:02:12 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"410"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chan_f8430cc9-feb5-4e93-bf93-14416575bd18\",\n \"date_created\": 1688659332,\n \"name\": \"My Channel\",\n \"owner\": {\n \"id\": \"usr_71cf6f96-8f59-4b80-b2a9-944a0520cf92\",\n \"email\": \"example@titanfile.com\"\n },\n \"date_expired\": 1683409907,\n \"is_expired\": true,\n \"bcc\": false,\n \"open_invitation\": false,\n \"external_folder_edit\": false,\n \"open_access\": false,\n \"safe_notification\": false,\n \"read_only\": false,\n \"requires_2fa\": true,\n \"channel_url\": \"https://app.titanfile.com/channels/vs8U4g/\"\n}"}],"_postman_id":"c6e131e5-d92c-4f60-a9a7-7bd491817a12"},{"name":"Update a channel","id":"316827d6-af18-41d5-a11f-4d2c2432c2fd","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"","description":"(Optional string) Name of the channel.
\n","type":"text","disabled":true},{"key":"expiry_date","value":"","description":"(Optional timestamp) Timestamp of when this channel expires.
\n","type":"text","disabled":true},{"key":"bcc","value":"","description":"(Optional boolean) Enable BCC on this channel.
\n","type":"text","disabled":true},{"key":"open_invitation","value":"","description":"(Optional boolean) Contacts can add new contacts.
\n","type":"text","disabled":true},{"key":"external_folder_edit","value":"","description":"(Optional boolean) External contacts can add/remove folders
\n","type":"text","disabled":true},{"key":"open_access","value":"","description":"(Optional boolean) Enable open access on this channel.
\n","type":"text","disabled":true},{"key":"safe_notification","value":"","description":"(Optional boolean) Enable safe notifications on this channel.
\n","type":"text","disabled":true},{"key":"read_only","value":"","description":"(Optional boolean) Enable read only on this channel.
\n","type":"text","disabled":true},{"key":"requires_2fa","value":"","description":"(Optional boolean) Require 2FA for free guest users.
\n","type":"text","disabled":true},{"key":"password","value":"","description":"(Optional string) Password that is required for external users to access the channel. Include an empty string to remove channel password.
\n","type":"text","disabled":true},{"key":"custom_fields","value":"","description":"(Optional string) A JSON string representation of a dictionary containing the channel's custom fields as the key-value pair. E.g. if you want to set the custom field \"Matter\" with the value \"M01\", you would use the JSON string {\"Matter\": \"M01\"}.
The channel options available for you to update will depend on your subscription.
\nA channel object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channels",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"description":{"content":"The ID of the channel.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"97ec4c2a-01e3-45f7-aa01-e39db06fb927","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"My Channel","description":"(Optional) Name of the channel.","type":"text"},{"key":"date_expired","value":"1683509907","description":"(Optional) Timestamp of when this channel expires.","type":"text"},{"key":"bcc","value":"True","description":"(Optional) Enable BCC on this channel.","type":"text"},{"key":"open_invitation","value":"false","description":"(Optional) Contacts can add new contacts.","type":"text","disabled":true},{"key":"external_folder_edit","value":"false","description":"(Optional) External contacts can add/remove folders","type":"text","disabled":true},{"key":"open_access","value":"false","description":"(Optional) Enable open access on this channel.","type":"text","disabled":true},{"key":"safe_notification","value":"false","description":"(Optional) Enable safe notifications on this channel.","type":"text","disabled":true},{"key":"read_only","value":"True","description":"(Optional) Enable read only on this channel.","type":"text"},{"key":"requires_2fa","value":"true","description":"(Optional) Require 2FA for free guest users.","type":"text","disabled":true}]},"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channels/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channels",":id",""],"variable":[{"key":"id","value":"chan_f8430cc9-feb5-4e93-bf93-14416575bd18"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Thu, 06 Jul 2023 16:10:32 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"413"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chan_f8430cc9-feb5-4e93-bf93-14416575bd18\",\n \"date_created\": 1688659332,\n \"name\": \"My Channel\",\n \"owner\": {\n \"id\": \"usr_71cf6f96-8f59-4b80-b2a9-944a0520cf92\",\n \"email\": \"example@titanfile.com\"\n },\n \"date_expired\": 1683509907,\n \"is_expired\": true,\n \"bcc\": true,\n \"open_invitation\": false,\n \"external_folder_edit\": false,\n \"open_access\": false,\n \"safe_notification\": false,\n \"read_only\": true,\n \"requires_2fa\": true,\n \"channel_url\": \"https://app.titanfile.com/channels/vs8U4g/\"\n}"}],"_postman_id":"316827d6-af18-41d5-a11f-4d2c2432c2fd"},{"name":"List channels","id":"d69d8772-71c7-4d70-8ff1-ccec86a7e1a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channels/","description":"A list of channel objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channels",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Optional enum) Filter on the following types of channels: active, starred, archived, draft. Default is active.
(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""},{"disabled":true,"description":{"content":"(Optional string) Filter by the email of the owner.
\n","type":"text/plain"},"key":"owner_email","value":""},{"disabled":true,"description":{"content":"(Optional string) If owner_email is not provided, filter by the owner user ID.
(Optional string) Filter by the channel name.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"(Optional integer) Filter channels created on or after this timestamp (Unix time in seconds e.g. 1756148830).
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"(Optional integer) Filter channels created on or before this timestamp (Unix time in seconds e.g. 1756148830).
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"(Optional boolean) When set to true, the response includes the channel size in bytes, calculated from the files stored in the channel. Default is false.
\n","type":"text/plain"},"key":"include_size","value":null}],"variable":[]}},"response":[{"id":"f3eb94cc-e2b4-4927-8b50-b46f78ef8150","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channels/?filter=active&limit=5","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channels",""],"query":[{"key":"filter","value":"active","description":"(Optional enum, default is `active`) Filter on the following types of channels: `active`, `starred`, `archived`, `cse`, `draft`, `trash`."},{"key":"limit","value":"5","description":"(Optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."},{"key":"starting_after","value":"","description":"(Optional) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.","disabled":true},{"key":"ending_before","value":"","description":"(Optional) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.","disabled":true},{"key":"include_size","value":null,"description":"(Optional boolean) When set to true, the response includes the channel size in bytes, calculated from the files stored in the channel. Default is false.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 12 May 2023 13:46:31 GMT"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 301,\n \"has_more\": true,\n \"data\": [\n {\n \"id\": \"chan_c41e16f7-1f6e-4224-b1f2-06e619c2865b\",\n \"created\": 1683831283,\n \"name\": \"Subscription Administrators Report\",\n \"owner\": {\n \"id\": \"usr_75660e4b-8ffa-4d17-8577-24647a133a47\",\n \"email\": \"example@titanfile.com\"\n },\n \"date_expired\": 1683509907,\n \"is_expired\": true,\n \"bcc\": true,\n \"open_invitation\": false,\n \"external_folder_edit\": false,\n \"open_access\": false,\n \"safe_notification\": false,\n \"read_only\": true,\n \"requires_2fa\": true\n },\n {\n \"id\": \"chan_a4631ec1-5228-415f-a1d8-17f21af94038\",\n \"created\": 1683658929,\n \"name\": \"Getting Started with TitanFile\",\n \"owner\": {\n \"id\": \"usr_75660e4b-8ffa-4d17-8577-24647a133a47\",\n \"email\": \"example@titanfile.com\"\n },\n \"date_expired\": 1683509907,\n \"is_expired\": true,\n \"bcc\": true,\n \"open_invitation\": false,\n \"external_folder_edit\": false,\n \"open_access\": false,\n \"safe_notification\": false,\n \"read_only\": true,\n \"requires_2fa\": true,\n \"channel_url\": \"https://app.titanfile.com/channels/ws8U4k/\"\n }\n ]\n}"}],"_postman_id":"d69d8772-71c7-4d70-8ff1-ccec86a7e1a1"},{"name":"Search channels","id":"6276a35e-c0ca-421a-90b2-9ce050a781f9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{subdomain}}.titanfile.com/api/v1/channels/search/","description":"A list of channel objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channels","search",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Required string) Query that searches against the channel name.
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"(Optional enum) Filter on the following types of channels: active, starred, archived, draft. Default is active.
(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit.","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""},{"disabled":true,"description":{"content":"(Optional boolean) When set to true, the response includes the channel size in bytes, calculated from the files stored in the channel. Default is false.
\n","type":"text/plain"},"key":"include_size","value":null}],"variable":[]}},"response":[{"id":"fe10ba3c-fa2d-469e-99e3-6512ad1596f7","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channels/search/?limit=5&query=test","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channels","search",""],"query":[{"key":"limit","value":"5","description":"(Optional) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."},{"key":"starting_after","value":"","description":"(Optional) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.","disabled":true},{"key":"ending_before","value":"","description":"(Optional) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.","disabled":true},{"key":"query","value":"test"},{"key":"include_size","value":null,"description":"(Optional boolean) When set to true, the response includes the channel size in bytes, calculated from the files stored in the channel. Default is false.","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 12 May 2023 13:46:31 GMT"},{"key":"content-type","value":"application/json"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"chan_c41e16f7-1f6e-4224-b1f2-06e619c2865b\",\n \"created\": 1683831283,\n \"name\": \"My Test Channel\",\n \"owner\": {\n \"id\": \"usr_75660e4b-8ffa-4d17-8577-24647a133a47\",\n \"email\": \"example@titanfile.com\"\n },\n \"date_expired\": 1683509907,\n \"is_expired\": true,\n \"bcc\": true,\n \"open_invitation\": false,\n \"external_folder_edit\": false,\n \"open_access\": false,\n \"safe_notification\": false,\n \"read_only\": true,\n \"requires_2fa\": true,\n \"channel_url\": \"https://app.titanfile.com/channels/Ss8U4k/\"\n }\n ]\n}"}],"_postman_id":"6276a35e-c0ca-421a-90b2-9ce050a781f9"}],"id":"46b5c6a2-d631-419f-bd77-2ed5c546ac4c","description":"id (string)
Unique identifier for the object.
date_created (timestamp)
Time at which the object was created. Measured in seconds since the Unix epoch.
owner (dictionary, expandable)
\nDetails of the user who owns the channel.
\nname (string)
Name of the channel.
is_expired (boolean)
If the channel is expired.
expiry_date (timestamp)
Time at which the channel expires. Measured in seconds since the Unix epoch.
bcc (boolean)
If BCC is enabled.
open_invitation (boolean)
If open invitation is enabled.
external_folder_edit (boolean)
If external contacts can add or remove folders.
open_access (boolean)
If open access is enabled.
safe_notification (boolean)
If safe notifications is enabled.
read_only (boolean)
If read only is enabled.
requires_2fa (boolean)
If free guest contacts are required to log in with two-factor to access the channel.
custom_fields (dictionary)
\nThe custom fields for the channel.
\nA channel contact object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_contacts",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"6c0211f2-3dc2-4794-aebb-504788db4545","description":{"content":"The ID of the channel contact.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"61b7daa5-db03-4565-b8fb-e6c48e29e8c5","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channel_contacts/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channel_contacts",":id",""],"variable":[{"key":"id","value":"chanusr_70fa600e-0b71-48af-a3b6-61acd452fcce","description":"Channel contact ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Apr 2023 01:33:28 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"261"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chc_70fa600e-0b71-48af-a3b6-61acd452fcce\",\n \"channel\": \"chan_2bf4b780-303a-4764-9a1f-79a690de0a7a\",\n \"user\": {\n \"id\": \"usr_5b934b58-30b0-45fe-8b00-852bedc2b365\",\n \"email\": \"example@titanfile.com\"\n },\n \"sharing_permissions\": \"contributor\",\n \"number_2fa\": null\n}"}],"_postman_id":"996b1191-0c41-41d7-b843-d1bb131c0ca0"},{"name":"Delete a channel contact","id":"b4792a70-9bbf-4793-9586-328151dd2fb4","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{subdomain}}.titanfile.com/api/v1/channel_contacts/:id/","description":"An object containing the ID of the successfully deleted channel contact object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_contacts",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"a8d15ddc-23b7-41d9-ad00-b580447e7b3f","description":{"content":"The ID of the channel contact.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fb0b6099-8dae-4934-8a4c-4b4215204bd9","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channel_contacts/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channel_contacts",":id",""],"variable":[{"key":"id","value":"chanusr_1cf7a963-daa4-41ed-b29e-f92d45620443","description":"Channel user ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 21 Apr 2023 01:40:05 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"71"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chc_1cf7a963-daa4-41ed-b29e-f92d45620443\",\n \"deleted\": true\n}"}],"_postman_id":"b4792a70-9bbf-4793-9586-328151dd2fb4"},{"name":"Create a channel contact","id":"ac21aac3-765c-4f2f-827e-db471ebbe842","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"channel","value":"","description":"(Required string) The ID of the channel.
\n","type":"text"},{"key":"email","value":"","description":"(Required string) The email of the contact.
\n","type":"text"},{"key":"first_name","value":"","description":"(Optional string) The first name of the contact.
\n","type":"text","disabled":true},{"key":"last_name","value":"","description":"(Optional string) The last name of the contact.
\n","type":"text","disabled":true},{"key":"organization","value":"","description":"(Optional string) The organization that the contact belongs to.
\n","type":"text","disabled":true},{"key":"add_to_panel","value":"","description":"(Optional boolean, default is true) Whether to add this contact to your contacts panel.
(Optional enum, default is subscription default) Sharing permission of contact. Possible values are limited_viewer, viewer, contributor, manager.
A channel contact object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_contacts",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[]}},"response":[{"id":"63b3bebd-7b4b-42be-b200-9d788c6d0f5f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"channel","value":"chan_1a95e50c-a064-471e-b68d-bb03c5edebf0","description":"(Required string) The ID of the channel.","type":"text"},{"key":"email","value":"example@titanfile.com","description":"(Required string) The email of the contact.","type":"text"},{"key":"first_name","value":"","description":"(Optional string) The first name of the contact.","type":"text","disabled":true},{"key":"last_name","value":"","description":"(Optional string) The last name of the contact.","type":"text","disabled":true},{"key":"organization","value":"","description":"(Optional string) The organization that the contact belongs to.","type":"text","disabled":true},{"key":"add_to_panel","value":"","description":"(Optional boolean, default is `true`) Whether to add this contact to your contacts panel.","type":"text","disabled":true},{"key":"sharing_permissions","value":"viewer","description":"(Optional enum, default is `contributor`) Sharing permission of contact. Possible values are `limited_viewer`, `viewer`, `contributor`, `manager`.","type":"text"}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/channel_contacts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 19 Jan 2024 20:21:01 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"299"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chc_4e1dea9e-32f5-49de-aee9-d9f86a1024aa\",\n \"channel\": \"chan_1a95e50c-a064-471e-b68d-bb03c5edebf0\",\n \"user\": {\n \"id\": \"usr_54836c51-598f-4ae2-b652-028df8761dfb\",\n \"email\": \"example@titanfile.com\"\n },\n \"most_recent_activity\": 1705695660,\n \"sharing_permissions\": \"viewer\",\n \"number_2fa\": null\n}"}],"_postman_id":"ac21aac3-765c-4f2f-827e-db471ebbe842"},{"name":"Update a channel contact","id":"98e2985c-7ad1-47e7-b28a-36b74ac535c0","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"sharing_permissions","value":"","description":"(Optional enum) Sharing permission of the contact. Possible values are limited_viewer, viewer, contributor, manager.
(Optional string) The contact's phone number used for 2FA. Use none to remove the contact's existing 2FA number.
A channel contact object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_contacts",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"ebab0861-fe97-46d2-8f5b-b1d6d4319f1e","description":{"content":"The ID of the channel contact.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"21e9ff61-2f4e-4592-bcf8-0b8784e7e6d5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"sharing_permissions","value":"manager","description":"(Optional enum) Sharing permission of the contact. Possible values are `limited_viewer`, `viewer`, `contributor`, `manager`.","type":"text"},{"key":"number_2fa","value":"","description":"(Optional string) The contact's phone number used for 2FA. Use `none` to remove the contact's existing 2FA number.","type":"text","disabled":true}]},"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channel_contacts/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channel_contacts",":id",""],"variable":[{"key":"id","value":"chc_4e1dea9e-32f5-49de-aee9-d9f86a1024aa","description":"The ID of the channel contact."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Fri, 19 Jan 2024 20:23:17 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"300"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, POST, DELETE, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chc_4e1dea9e-32f5-49de-aee9-d9f86a1024aa\",\n \"channel\": \"chan_1a95e50c-a064-471e-b68d-bb03c5edebf0\",\n \"user\": {\n \"id\": \"usr_54836c51-598f-4ae2-b652-028df8761dfb\",\n \"email\": \"example@titanfile.com\"\n },\n \"most_recent_activity\": 1705695660,\n \"sharing_permissions\": \"manager\",\n \"number_2fa\": null\n}"}],"_postman_id":"98e2985c-7ad1-47e7-b28a-36b74ac535c0"},{"name":"List channel contacts","id":"9dea2cb4-ba6f-4c6c-8ad6-b29e2465f198","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channel_contacts/","description":"A list of channel contact objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_contacts",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Required string) Channel ID.
\n","type":"text/plain"},"key":"channel","value":""},{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""},{"disabled":true,"description":{"content":"(Optional string) Filter by the given email.
\n","type":"text/plain"},"key":"email","value":""},{"disabled":true,"description":{"content":"(Optional string) If email is not provided, filter by the given user ID.
id (string)
Unique identifier for the object.
channel (string, expandable)
ID of the channel that the user belongs to.
user (dictionary, expandable)
User details.
sharing_permissions (enum)
Sharing permission of the user. Possible values are limited_viewer, viewer, contributor, manager.
number_2fa (string)
The user's phone number used for 2FA.
A channel file object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_files",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"9f2ebe0a-9b9d-4742-a258-4a20f28d128d","description":{"content":"The ID of the channel file.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6d55feeb-ce76-4b29-a041-66fc1e6db712","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/channel_files/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","channel_files",":id",""],"variable":[{"key":"id","value":"chf_cd06f4db-b61d-43c2-8cb3-eaacf94a11df","description":"The ID of the channel file."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"date","value":"Wed, 17 Jan 2024 21:41:19 GMT"},{"key":"content-type","value":"application/json"},{"key":"content-length","value":"431"},{"key":"vary","value":"Accept, Accept-Language, Cookie"},{"key":"allow","value":"GET, HEAD, OPTIONS"},{"key":"x-frame-options","value":"ALLOWALL"},{"key":"content-language","value":"en-us"},{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-headers","value":"authorization"},{"key":"access-control-allow-methods","value":"POST, GET, OPTIONS"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chf_cd06f4db-b61d-43c2-8cb3-eaacf94a11df\",\n \"channel\": \"chan_5826b468-b586-47aa-8534-f207346dbcf6\",\n \"owner\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"message\": \"msg_0ccdb1b4-7cd9-42e2-852f-2be57e47f6b5\",\n \"name\": \"my_image.png\",\n \"path\": \"/Test folder/my_image.png\",\n \"type\": \"png\",\n \"size\": 4408,\n \"date_created\": 1705445993,\n \"is_latest_revision\": true\n}"}],"_postman_id":"51e498c2-8126-4fd1-9cf9-bdd56890395b"},{"name":"Download a channel file","id":"974fdfa5-3df8-4b6e-aa86-a625ef473977","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channel_files/download/:id/","description":"The contents of a channel file.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_files","download",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"9304a378-d76d-4c90-976c-b55ec4962805","description":{"content":"The ID of the channel file.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"974fdfa5-3df8-4b6e-aa86-a625ef473977"},{"name":"Download channel files as zip","id":"38a09e5e-037b-48ae-aea6-fe4dbd9c6a61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channel_files/download_zip/","description":"A zip archive of channel files.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_files","download_zip",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Required string) The ID of the channel.
\n","type":"text/plain"},"key":"channel","value":""},{"disabled":true,"description":{"content":"(Optional timestamp) Unix timestamp to filter for channel files created on or after this date.
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"(Optional timestamp) Unix timestamp to filter for channel files created on or before this date.
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"(Optional boolean, default is false) Exclude files that have already been downloaded.
(Optional string) Download the files at this folder path.
\n","type":"text/plain"},"key":"folder_path","value":null}],"variable":[]}},"response":[],"_postman_id":"38a09e5e-037b-48ae-aea6-fe4dbd9c6a61"},{"name":"List channel files","id":"f4f0e8a2-c494-493a-a3ac-28557da553e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/channel_files/","description":"A list of channel file objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","channel_files",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Required string) The ID of the channel.
\n","type":"text/plain"},"key":"channel","value":""},{"disabled":true,"description":{"content":"(Optional string) Return channel files that were sent in the message given by this message ID.
\n","type":"text/plain"},"key":"message","value":""},{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""},{"disabled":true,"description":{"content":"(Optional timestamp) Unix timestamp to filter for channel files created on or after this date.
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"(Optional timestamp) Unix timestamp to filter for channel files created on or before this date.
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"(Optional boolean, default is false) Exclude files that have already been downloaded.
(Optional boolean, default is true) Include folders in the response.
(Required string) The ID of the channel.
\n","type":"text"},{"key":"owner_email","value":"","description":"(Optional string) Email of the user who you are sending the message on behalf of. You must have delegation rights for this user.
\n","type":"text","disabled":true},{"key":"message_html","value":"","description":"(Optional string) Message text. May be formatted with HTML.
\n","type":"text","disabled":true},{"key":"files","description":"(Optional file) Files to send.
\n","type":"file","value":null,"disabled":true},{"key":"folder_path","value":"","description":"(Optional string) Upload files to the given folder path. Folders that do not exist will not be automatically created unless create_folders is set to true.
(Optional boolean, default is false) Automatically create folders that do not exist.
(Optional boolean, default is true) Notify channel contacts about the new message.
This endpoint is an alias to the Send a message endpoint. Including a message body (i.e. message_html) is optional.
A message object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","messages",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[]}},"response":[{"id":"a8c6774c-3fc4-49be-8933-1f54e358d95c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"*/*; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"channel","value":"chan_e70c3af6-6cec-4247-a53c-c73ae938f739","description":"(Required) The ID of the channel.","type":"text"},{"key":"owner_email","value":"jessica.tr.huynh@gmail.com","description":"(Optional) Email of the user who you are sending the message on behalf of. You must have delegation rights for this user.","type":"text","disabled":true},{"key":"message_html","value":"HelloHello
Here is my file.
id (string)
Unique identifier for the object.
date_created (timestamp)
Time at which the object was created. Measured in seconds since the Unix epoch.
channel (string, expandable)
The ID of the channel that the file was uploaded to.
owner (dictionary, expandable)
\nDetails of the user who owns the file.
\nmessage (string, expandable)
The ID of the message that the file was sent with.
name (string)
Name of the file.
type (string)
File type.
path (string)
Full path of the file.
size (integer)
Size of the file in bytes.
is_latest_revision (boolean)
If the file is the latest version.
(Required string) The ID of the channel.
\n","type":"text"},{"key":"owner_email","value":"","description":"(Optional string) Email of the user who you are sending the message on behalf of. You must have delegation rights for this user.
\n","type":"text","disabled":true},{"key":"message_html","value":"","description":"(Optional string) Message text. May be formatted with HTML.
\n","type":"text","disabled":true},{"key":"files","description":"(Optional file) Files to send.
\n","type":"file","value":null,"disabled":true},{"key":"folder_path","value":"","description":"(Optional string) Upload files to the given folder path. Folders that do not exist will not be automatically created unless create_folders is set to true.
(Optional boolean, default is false) Automatically create folders that do not exist.
(Optional boolean, default is true) Notify channel contacts about the new message.
A message object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","messages",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[]}},"response":[{"id":"b396db0f-21b7-4743-918b-c33eadcca39f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"*/*; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"channel","value":"chan_e70c3af6-6cec-4247-a53c-c73ae938f739","description":"(Required) The ID of the channel.","type":"text"},{"key":"owner_email","value":"jessica.tr.huynh@gmail.com","description":"(Optional) Email of the user who you are sending the message on behalf of. You must have delegation rights for this user.","type":"text","disabled":true},{"key":"message_html","value":"HelloHello
Here is my file.
id (string)
Unique identifier for the object.
date_created (timestamp)
Time at which the object was created. Measured in seconds since the Unix epoch.
channel (string, expandable)
The ID of the channel that the message was sent in.
owner (dictionary, expandable)
\nDetails of the user who sent the message.
\nmessage_html (string)
The text of the message in HTML format.
file_count (integer)
The number of files sent with the message.
folder_count (integer)
The number of (new) folders sent with the message.
A log object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","logs",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"6780ebb4-8c62-4cfb-b51d-bff7ed3e9840","description":{"content":"The ID of the log.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"19b10cf5-b185-4ab0-b420-c40472643141","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/logs/:id/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","logs",":id",""],"variable":[{"key":"id","value":"log_a40ff54c-4f68-4c83-8ef8-a9af77eb6a43","description":"The ID of the log."}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"log_a40ff54c-4f68-4c83-8ef8-a9af77eb6a43\",\n \"date_created\": 1711484835,\n \"event\": {\n \"code\": \"reports_file_download\",\n \"description\": \"John Smith downloaded \\\"Test Channel - 2024-03-26.pdf\\\" from the log exports tab.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": null,\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": {\n \"id\": \"file_f6d5b5da-d6b8-438b-bf8b-98c7e2628e82\",\n \"name\": \"Test Channel - 2024-03-26.pdf\",\n \"original_file_id\": null,\n \"sha_digest\": \"SHA2:bfda495b44f4b2162a4ab5da5ee0aa7212905d9bbde7bfa1b9b9b50618b8d60a\",\n \"size\": 34373,\n \"num_downloads\": null\n },\n \"delegate\": null,\n \"contact\": null\n}"}],"_postman_id":"8a0cf2a8-f3c8-468b-b118-705a8b594ab8"},{"name":"List logs","id":"2f630175-7e8c-4f70-b44c-ce49be166d8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/logs/","description":"A list of log objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","logs",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Optional string) Return logs associated with the channel given by this channel ID.
\n","type":"text/plain"},"key":"channel","value":""},{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""},{"disabled":true,"description":{"content":"(Optional timestamp) Unix timestamp to filter for logs created on or after this date.
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"(Optional timestamp) Unix timestamp to filter for logs created on or before this date.
\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[{"id":"e115a650-3d44-43d5-8128-5c19bd2c6735","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; version=1.0","type":"text"}],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/logs/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","logs",""],"query":[{"key":"channel","value":"","description":"(Optional string) Return logs associated with the channel given by this channel ID.","disabled":true},{"key":"limit","value":"","description":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","disabled":true},{"key":"starting_after","value":"","description":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.","disabled":true},{"key":"ending_before","value":"","description":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.","disabled":true},{"key":"start_date","value":"","description":"(Optional timestamp) Unix timestamp to filter for logs created on or after this date.","disabled":true},{"key":"end_date","value":"","description":"(Optional timestamp) Unix timestamp to filter for logs created on or before this date.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1000,\n \"has_more\": true,\n \"data\": [\n {\n \"id\": \"log_a40ff54c-4f68-4c83-8ef8-a9af77eb6a43\",\n \"date_created\": 1711484835,\n \"event\": {\n \"code\": \"reports_file_download\",\n \"description\": \"John Smith downloaded \\\"Test Channel - 2024-03-26.pdf\\\" from the log exports tab.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": null,\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": {\n \"id\": \"file_f6d5b5da-d6b8-438b-bf8b-98c7e2628e82\",\n \"name\": \"Test Channel - 2024-03-26.pdf\",\n \"original_file_id\": null,\n \"sha_digest\": \"SHA2:bfda495b44f4b2162a4ab5da5ee0aa7212905d9bbde7bfa1b9b9b50618b8d60a\",\n \"size\": 34373,\n \"num_downloads\": null\n },\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_15ce9669-3d4f-430d-b7d0-3799ba2a83cc\",\n \"date_created\": 1711484833,\n \"event\": {\n \"code\": \"channel_conversation_export\",\n \"description\": \"John Smith exported conversation as PDF from \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": null,\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_96e7726f-71cf-4c6f-bedf-996f90fbb8d6\",\n \"date_created\": 1711484767,\n \"event\": {\n \"code\": \"channel_folder_add\",\n \"description\": \"John Smith added \\\"New Folder (1)\\\" folder to \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": {\n \"id\": \"chf_07259633-f3d8-4929-88f9-ad66f55be39f\",\n \"name\": \"New Folder (1)\",\n \"original_file_id\": null,\n \"sha_digest\": null,\n \"size\": null,\n \"num_downloads\": null\n },\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_d5ead01d-4cf0-4fe3-80b4-35eb54eeeaa1\",\n \"date_created\": 1711484767,\n \"event\": {\n \"code\": \"message_create\",\n \"description\": \"John Smith sent a new message to \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": \"msg_dfa227fc-fb22-4bae-9fb9-6cbeeca17660\",\n \"ip_address\": \"10.10.10.10\",\n \"file\": null,\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_f536372f-901f-43f3-905d-0f8e5b179d90\",\n \"date_created\": 1711484758,\n \"event\": {\n \"code\": \"channel_file_download\",\n \"description\": \"John Smith downloaded \\\"test.pdf\\\" file from \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": {\n \"id\": \"chf_cb2bd7bf-88fe-480d-9745-1f4461c9e776\",\n \"name\": \"test.pdf\",\n \"original_file_id\": null,\n \"sha_digest\": \"SHA2:ed63c4d8bfaee709ad646cdc8fd5cb3ad9c54072782d606f8dca7ca8660209ca\",\n \"size\": 12837,\n \"num_downloads\": 2\n },\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_bb1031e4-019f-4693-9e1b-950b6dd65212\",\n \"date_created\": 1711484754,\n \"event\": {\n \"code\": \"channel_file_preview\",\n \"description\": \"John Smith previewed \\\"test.pdf\\\" file from \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": {\n \"id\": \"chf_cb2bd7bf-88fe-480d-9745-1f4461c9e776\",\n \"name\": \"test.pdf\",\n \"original_file_id\": null,\n \"sha_digest\": \"SHA2:ed63c4d8bfaee709ad646cdc8fd5cb3ad9c54072782d606f8dca7ca8660209ca\",\n \"size\": 12837,\n \"num_downloads\": 2\n },\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_0d978fbd-d8d2-4f1b-a907-bce53fa2147c\",\n \"date_created\": 1711484749,\n \"event\": {\n \"code\": \"channel_file_upload\",\n \"description\": \"John Smith uploaded \\\"test.pdf\\\" file to \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": {\n \"id\": \"chf_cb2bd7bf-88fe-480d-9745-1f4461c9e776\",\n \"name\": \"test.pdf\",\n \"original_file_id\": null,\n \"sha_digest\": \"SHA2:ed63c4d8bfaee709ad646cdc8fd5cb3ad9c54072782d606f8dca7ca8660209ca\",\n \"size\": 12837,\n \"num_downloads\": 2\n },\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_64a6f659-919e-4841-a3f0-41fc146ec57e\",\n \"date_created\": 1711484749,\n \"event\": {\n \"code\": \"message_create\",\n \"description\": \"John Smith sent a new message with 1 file to \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": \"msg_11b89fb9-b3ab-4bd0-b1cc-b08d04e779a4\",\n \"ip_address\": \"10.10.10.10\",\n \"file\": null,\n \"delegate\": null,\n \"contact\": null\n },\n {\n \"id\": \"log_98099d49-2eec-44e9-893f-e90226de4e64\",\n \"date_created\": 1711484730,\n \"event\": {\n \"code\": \"channel_contact_add\",\n \"description\": \"John Smith added Jane Doe to \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": null,\n \"delegate\": null,\n \"contact\": {\n \"id\": \"usr_230852fc-ead0-41b3-91b9-7e3669c54aa3\",\n \"email\": \"contact@titanfile.com\"\n }\n },\n {\n \"id\": \"log_9d0c4211-b05f-4bad-8fa8-342206b26d26\",\n \"date_created\": 1711484720,\n \"event\": {\n \"code\": \"channel_create\",\n \"description\": \"John Smith created \\\"Test Channel\\\" channel.\"\n },\n \"user\": {\n \"id\": \"usr_0e919973-821a-4eea-ae6d-77dbd8cdadcf\",\n \"email\": \"example@titanfile.com\"\n },\n \"channel\": {\n \"id\": \"chan_5a725816-e74e-441b-8c34-5b6dc971b8aa\",\n \"name\": \"Test Channel\"\n },\n \"channel_message\": null,\n \"ip_address\": \"10.10.10.10\",\n \"file\": null,\n \"delegate\": null,\n \"contact\": null\n }\n ]\n}"}],"_postman_id":"2f630175-7e8c-4f70-b44c-ce49be166d8c"}],"id":"11e46937-99e2-4d26-9ee0-0aa48c2d8d04","description":"id (string)
Unique identifier for the object.
date_created (timestamp)
Time at which the object was created. Measured in seconds since the Unix epoch.
event (dictionary)
Details of the event being logged.
user (dictionary, expandable)
\nDetails of the user associated with the log.
\nchannel (dictionary, expandable)
\nDetails of channel associated with the log.
\nchannel_message (string, expandable)
ID of the channel message associated with the log.
channel_custom_fields (string)
The custom fields for the channel. Only included for channel_create events.
ip_address (string)
The IP address of the user associated with the log.
file (dictionary)
Details of the file associated with the log.
delegate (dictionary, expandable)
\nDetails of the delegate user if delegation was used.
\ncontact (dictionary, expandable)
\nDetails of the contact associated with the log.
\nA channel object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","channels",":id"],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"id":"54c9fc82-f46f-438e-a44a-5c2ebf4d53bf","description":{"content":"The ID of the channel.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ce9a93d5-e8e9-48fe-b4a0-881a83bd957f"},{"name":"List subscription's channels","id":"aa516ab1-b285-404a-80ac-38aaadbcb23e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*; version=1.0"}],"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/channels/","description":"A list of channel objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","channels",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""},{"disabled":true,"description":{"content":"(Optional string) Filter by the email of the owner.
\n","type":"text/plain"},"key":"owner_email","value":""},{"disabled":true,"description":{"content":"(Optional string) If owner_email is not provided, filter by the owner user ID.
(Optional string) Filter by the channel name.
\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"(Optional integer) Filter channels created on or after this timestamp (Unix time in seconds e.g. 1756148830).
\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"(Optional integer) Filter channels created on or before this timestamp (Unix time in seconds e.g. 1756148830).
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"(Optional boolean) Include deleted channels in the list. Default is true.
\n","type":"text/plain"},"key":"include_deleted","value":null}],"variable":[]}},"response":[],"_postman_id":"aa516ab1-b285-404a-80ac-38aaadbcb23e"},{"name":"Search subscription's channels","id":"5d53344d-4222-49d4-bc67-be2bbb541752","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*; version=1.0","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/channels/search/","description":"A list of channel objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","channels","search",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Required string) Query that searches against the channel name.
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""}],"variable":[]}},"response":[],"_postman_id":"5d53344d-4222-49d4-bc67-be2bbb541752"},{"name":"Transfer channel ownership","id":"22b042eb-63fe-41ce-a7ce-cf9b50791f46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"owner","value":"","type":"text","description":"(Required string) Email of the new channel owner.
\n","disabled":true}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/channels/:id/transfer/","description":"A channel object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","channels",":id","transfer",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"description":{"content":"The ID of the channel.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"25c1777d-68f7-440b-9572-c4b82014250c","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"owner","value":"primary@titanfile.com","type":"text","description":"(Required string) Email of the new channel owner."}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/channels/chan_284891a3-7e42-4bdb-8140-0b5b996028cf/transfer/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"chan_284891a3-7e42-4bdb-8140-0b5b996028cf\",\n \"date_created\": 1753295395,\n \"name\": \"Test Channel\",\n \"owner\": {\n \"id\": \"usr_10e93ac7-83bc-448b-97f8-02e8865aae8a\",\n \"email\": \"primary@titanfile.com\"\n },\n \"expiry_date\": null,\n \"is_expired\": null,\n \"custom_fields\": {\n \"File Number\": \"1234\"\n },\n \"channel_admins\": [\n \"primary@titanfile.com\",\n \"example@titanfile.com\"\n ],\n \"restricted_file_exts\": [],\n \"password_protected\": false,\n \"bcc\": true,\n \"open_invitation\": false,\n \"external_folder_edit\": true,\n \"open_access\": false,\n \"safe_notification\": false,\n \"read_only\": true,\n \"requires_2fa\": false\n}"}],"_postman_id":"22b042eb-63fe-41ce-a7ce-cf9b50791f46"}],"id":"e70b6f67-a14b-4621-ad58-a90f3337157e","description":"id (string)
Unique identifier for the object.
date_created (timestamp)
Time at which the object was created. Measured in seconds since the Unix epoch.
owner (dictionary, expandable)
\nDetails of the user who owns the channel.
\nname (string)
Name of the channel.
is_expired (boolean)
If the channel is expired.
expiry_date (timestamp)
Time at which the channel expires. Measured in seconds since the Unix epoch.
bcc (boolean)
If BCC is enabled.
open_invitation (boolean)
If open invitation is enabled.
external_folder_edit (boolean)
If external contacts can add or remove folders.
open_access (boolean)
If open access is enabled.
safe_notification (boolean)
If safe notifications is enabled.
read_only (boolean)
If read only is enabled.
requires_2fa (boolean)
If free guest contacts are required to log in with two-factor to access the channel.
custom_fields (dictionary)
\nThe custom fields for the channel.
\nA user object
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","users",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"description":{"content":"The user ID of the subscription member.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ed3ecc41-d50b-4d5b-9d39-217a45fcc59f","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/usr_221c45d0-5e51-481f-a110-731329833b1e/"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"usr_221c45d0-5e51-481f-a110-731329833b1e\",\n \"email\": \"example@titanfile.com\",\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"company\": \"\",\n \"is_subscription_admin\": true,\n \"is_channel_admin\": false,\n \"is_limited_user\": false,\n \"show_in_secure_submit_list\": false\n}"}],"_postman_id":"b9ecc875-465f-456b-87de-d6997adfe90a"},{"name":"Remove a subscription member","id":"49c0f9db-440f-4ae1-b1e9-8f03389f89ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"remove_from_shared_contacts","value":"","type":"text","description":"(Optional boolean) Remove the member from the subscription's shared contacts list.
\n","disabled":true},{"key":"notify_member","value":"","type":"text","description":"(Optional boolean) Notify the member of their removal.
\n","disabled":true},{"key":"remove_from_channels","value":"","type":"text","description":"(Optional boolean) Remove the member from all channels they are apart of.
\n","disabled":true},{"key":"transfer_channels_to_email","value":"","type":"text","description":"(Optional string) Transfer all channels owned by this member to another subscription member with this email.
\n","disabled":true}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/:id/","description":"An object containing the ID of the successfully deleted user object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","users",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"description":{"content":"The user ID of the subscription member.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"72fefb8a-c156-4d21-9c27-15f1b1a2300b","name":"Success","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"key":"remove_from_shared_contacts","value":"true","type":"text","description":"(Optional boolean) Remove the member from the subscription's shared contacts list."},{"key":"notify_member","value":"false","type":"text","description":"(Optional boolean) Notify the member of their removal."},{"key":"remove_from_channels","value":"true","type":"text","description":"(Optional boolean) Remove the member from all channels they are apart of."},{"key":"transfer_channels_to_email","value":"primary@titanfile.com","type":"text","description":"(Optional string) Transfer all channels owned by this member to another subscription member with this email."}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/usr_221c45d0-5e51-481f-a110-731329833b1e/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"usr_221c45d0-5e51-481f-a110-731329833b1e\",\n \"deleted\": true\n}"}],"_postman_id":"49c0f9db-440f-4ae1-b1e9-8f03389f89ac"},{"name":"Add a subscription member","id":"ceb0c1da-4fae-4cc3-94ff-953a417efbd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"","type":"text","description":"(Required string) Email of the member.
\n","disabled":true},{"key":"first_name","value":"","type":"text","description":"(Optional string) First name of the member.
\n","disabled":true},{"key":"last_name","value":"","type":"text","description":"(Optional string) Last name of the member.
\n","disabled":true},{"key":"is_subscription_admin","value":"","type":"text","description":"(Optional string) This member is a subscriptin administrator.
\n","disabled":true},{"key":"is_channel_admin","value":"","type":"text","description":"(Optional string) This member is a channel administrator.
\n","disabled":true},{"key":"is_limited_user","value":"","type":"text","description":"(Optional string) This member is a limited user. This change will only be in effect if the subscription has 'Show Limited User Role' enabled.
\n","disabled":true},{"key":"show_in_secure_submit_list","value":"","type":"text","description":"(Optional string) This member appears in the subscription's Secure Submit page.
\n","disabled":true}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/","description":"A user object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","users",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[]}},"response":[{"id":"ec75cdde-40f3-4ea9-8e02-fd0e17ecb0d1","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"example@titanfile.com","type":"text","description":"(Required string) Email of the member."},{"key":"first_name","value":"Test","type":"text","description":"(Optional string) First name of the member."},{"key":"last_name","value":"Test","type":"text","description":"(Optional string) Last name of the member."},{"key":"is_subscription_admin","value":"true","type":"text","description":"(Optional string) This member is a subscriptin administrator."},{"key":"is_channel_admin","value":"false","type":"text","description":"(Optional string) This member is a channel administrator."},{"key":"is_limited_user","value":"false","type":"text","description":"(Optional string) This member is a limited user."},{"key":"show_in_secure_submit_list","value":"false","type":"text","description":"(Optional string) This member appears in the subscription's Secure Submit page."}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"usr_221c45d0-5e51-481f-a110-731329833b1e\",\n \"email\": \"example@titanfile.com\",\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"company\": \"\",\n \"is_subscription_admin\": true,\n \"is_channel_admin\": false,\n \"is_limited_user\": false,\n \"show_in_secure_submit_list\": false\n}"}],"_postman_id":"ceb0c1da-4fae-4cc3-94ff-953a417efbd8"},{"name":"Update a subscription member","id":"419b398a-b0f4-4444-a0ff-95d1ede9ec0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"","type":"text","description":"(Optional string) Email of the member.
\n","disabled":true},{"key":"first_name","value":"","type":"text","description":"(Optional string) First name of the member.
\n","disabled":true},{"key":"last_name","value":"","type":"text","description":"(Optional string) Last name of the member.
\n","disabled":true},{"key":"is_subscription_admin","value":"","type":"text","description":"(Optional string) This member is a subscriptoin administrator.
\n","disabled":true},{"key":"is_channel_admin","value":"","type":"text","description":"(Optional string) This member is a channel administrator.
\n","disabled":true},{"key":"is_limited_user","value":"","type":"text","description":"(Optional string) This member is a limited user. This change will only be in effect if the subscription has 'Show Limited User Role' enabled.
\n","disabled":true},{"key":"show_in_secure_submit_list","value":"","type":"text","description":"(Optional string) This member appears in the subscription's Secure Submit page.
\n","disabled":true}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/:id/","description":"A user object.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","users",":id",""],"host":["{{subdomain}}","titanfile","com"],"query":[],"variable":[{"description":{"content":"The user ID of the subscription member.
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"444a468a-ee04-488a-a666-9025ec35b02b","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"","type":"text","description":"(Optional string) Email of the member.","disabled":true},{"key":"first_name","value":"First","type":"text","description":"(Optional string) First name of the member."},{"key":"last_name","value":"Last","type":"text","description":"(Optional string) Last name of the member."},{"key":"is_subscription_admin","value":"false","type":"text","description":"(Optional string) This member is a subscriptoin administrator."},{"key":"is_channel_admin","value":"true","type":"text","description":"(Optional string) This member is a channel administrator."},{"key":"is_limited_user","value":"","type":"text","description":"(Optional string) This member is a limited user.","disabled":true},{"key":"show_in_secure_submit_list","value":"","type":"text","description":"(Optional string) This member appears in the subscription's Secure Submit page.","disabled":true}]},"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/usr_221c45d0-5e51-481f-a110-731329833b1e/"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"id\": \"usr_221c45d0-5e51-481f-a110-731329833b1e\",\n \"email\": \"example@titanfile.com\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company\": \"\",\n \"is_subscription_admin\": false,\n \"is_channel_admin\": true,\n \"is_limited_user\": false,\n \"show_in_secure_submit_list\": false\n}"}],"_postman_id":"419b398a-b0f4-4444-a0ff-95d1ede9ec0d"},{"name":"List subscription members","id":"ed961fd3-0835-4d6c-a8d3-e6b7b8a0f274","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/","description":"A list of user objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","users",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. You may pass either starting_after or ending_before, but not both. If both are provided, only starting_after will be used.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. You may pass either starting_after or ending_before, but not both. If both are provided, only starting_after will be used.
\n","type":"text/plain"},"key":"ending_before","value":""}],"variable":[]}},"response":[{"id":"6cc0ad77-6052-4ee9-b52c-c39c39f41d56","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","subscription","users",""],"query":[{"key":"limit","value":"","description":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","type":"text","disabled":true},{"key":"starting_after","value":"","description":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. You may pass either starting_after or ending_before, but not both. If both are provided, only starting_after will be used.","type":"text","disabled":true},{"key":"ending_before","value":"","description":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. You may pass either starting_after or ending_before, but not both. If both are provided, only starting_after will be used.","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"usr_221c45d0-5e51-481f-a110-731329833b1e\",\n \"email\": \"example@titanfile.com\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company\": \"\",\n \"is_subscription_admin\": false,\n \"is_channel_admin\": true,\n \"is_limited_user\": false,\n \"show_in_secure_submit_list\": false\n },\n {\n \"id\": \"usr_10e93ac7-83bc-448b-97f8-02e8865aae8a\",\n \"email\": \"primary@titanfile.com\",\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"company\": \"\",\n \"is_subscription_admin\": true,\n \"is_channel_admin\": true,\n \"is_limited_user\": false,\n \"show_in_secure_submit_list\": true\n }\n ]\n}"}],"_postman_id":"ed961fd3-0835-4d6c-a8d3-e6b7b8a0f274"},{"name":"Search subscription members","id":"1b0bac06-181d-4e9c-949a-4bdb530f35d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/search/","description":"A list of user objects.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v1","subscription","users","search",""],"host":["{{subdomain}}","titanfile","com"],"query":[{"disabled":true,"description":{"content":"(Required string) Query that searched against the member email and name.
\n","type":"text/plain"},"key":"query","value":""},{"disabled":true,"description":{"content":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
\n","type":"text/plain"},"key":"limit","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
\n","type":"text/plain"},"key":"starting_after","value":""},{"disabled":true,"description":{"content":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
\n","type":"text/plain"},"key":"ending_before","value":""}],"variable":[]}},"response":[{"id":"e0328c39-4fff-48b7-9dff-194c2ba61197","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdomain}}.titanfile.com/api/v1/subscription/users/search/?query=example","protocol":"https","host":["{{subdomain}}","titanfile","com"],"path":["api","v1","subscription","users","search",""],"query":[{"key":"query","value":"example","description":"(Required string) Query that searched against the member email and name.","type":"text"},{"key":"limit","value":"","description":"(Optional integer) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.","type":"text","disabled":true},{"key":"starting_after","value":"","description":"(Optional string) A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.","type":"text","disabled":true},{"key":"ending_before","value":"","description":"(Optional string) A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.","type":"text","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"has_more\": false,\n \"data\": [\n {\n \"id\": \"usr_221c45d0-5e51-481f-a110-731329833b1e\",\n \"email\": \"example@titanfile.com\",\n \"first_name\": \"First\",\n \"last_name\": \"Last\",\n \"company\": \"\",\n \"is_subscription_admin\": false,\n \"is_channel_admin\": true,\n \"is_limited_user\": false,\n \"show_in_secure_submit_list\": false\n }\n ]\n}"}],"_postman_id":"1b0bac06-181d-4e9c-949a-4bdb530f35d9"}],"id":"05901d51-c143-459d-9246-f3dd7eed1130","description":"id (string)
Unique identifier for the object.
email (string)
Email of the user.
first_name (string)
First name of the user.
last_name (string)
Last name of the user.
company (string)
The company of the user.
is_subscription_admin (string)
If the user is a subscription administrator.
is_channel_admin (string)
If the user is a channel administrator.
is_limited_user (string)
If the user is a limited user.
show_in_secure_submit_list (string)
If the user is shown in their subscription's Secure Submit page.
The endpoints in this section are only available to subscription administrators.
\n","_postman_id":"de2be120-304a-4d6d-851d-30d1f612d0d7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","id":"73d963aa-f370-4e9c-b88c-7c2b21c82ab3","name":"TitanFile API v1","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"7f13a81a-6e5e-4861-8e31-92358835b6d6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e1335515-81e1-47df-9bb3-677016e35a00","type":"text/javascript","exec":[""]}}]}