Skip to content
Changelog

Report a bug

Dropbox integration: operations for AI agents

Dropbox connects to Type.com as an integration. This page lists the 276 operations documented for Claude and Codex in Type.com: 135 read, 74 write, 67 destructive.

About Dropbox

Dropbox API v2 reference covering JSON RPC, content protocols and team operations, with explicit raw-upload, destination, scope and legacy Paper limitations. Managed Pipedream actions are a separate conditional surface.

Categories: Files & Storage

How to connect Dropbox to Type.com

Connect
Managed Pipedream OAuth when workspace-enabled; no direct provider-specific target/auth preset is configured
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

276 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

276 operations listed.

Account

  • Read

    This lovely endpoint gets the account photo of a given user

    This lovely endpoint gets the account photo of a given user.

    POST /2/account/get_photo

  • Write

    Sets a user's profile photo

    Sets a user's profile photo.

    POST /2/account/set_profile_photo

  • Destructive

    Deletes the current user's profile photo

    Deletes the current user's profile photo.

    POST /2/account/delete_profile_photo

Auth

  • Write

    Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token (deprecated)

    Creates an OAuth 2.0 access token from the supplied OAuth 1.0 access token.

    POST /2/auth/token/from_oauth1

  • Destructive

    Disables the access token used to authenticate the call

    Disables the access token used to authenticate the call. If there is a corresponding refresh token for the access token, this disables that refresh token, as well as any other access tokens for that refresh token.

    POST /2/auth/token/revoke

Check

  • Read

    Check connected-user API connectivity

    This endpoint performs User Authentication, validating the supplied access token, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the access token is valid.

    POST /2/check/user

  • Read

    Check app-authenticated API connectivity

    This endpoint performs App Authentication, validating the supplied app key and secret, and returns the supplied string, to allow you to test your code and connection to the Dropbox API. It has no other effect. If you receive an HTTP 200 response with the supplied query, it indicates at least part of the Dropbox API infrastructure is working and that the app key and secret valid.

    POST /2/check/app

Contacts

  • Destructive

    Removes all manually added contacts

    Removes all manually added contacts. You'll still keep contacts who are on your team or who you imported. New contacts will be added when you share.

    POST /2/contacts/delete_manual_contacts

  • Destructive

    Removes manually added contacts from the given list

    Removes manually added contacts from the given list.

    POST /2/contacts/delete_manual_contacts_batch

File Properties

  • Read

    Search across property templates for particular property field values

    Search across property templates for particular property field values.

    POST /2/file_properties/properties/search

  • Read

    Once a cursor has been retrieved from :route:`properties/search`, use this to paginate through all search results

    Once a cursor has been retrieved from :route:`properties/search`, use this to paginate through all search results.

    POST /2/file_properties/properties/search/continue

  • Read

    Get the schema for a specified template

    Get the schema for a specified template.

    POST /2/file_properties/templates/get_for_team

  • Read

    Get the schema for a specified template

    Get the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.

    POST /2/file_properties/templates/get_for_user

  • Read

    Get the template identifiers for a team

    Get the template identifiers for a team. To get the schema of each template use :route:`templates/get_for_team`.

    POST /2/file_properties/templates/list_for_team

  • Read

    Get the template identifiers for a team

    Get the template identifiers for a team. To get the schema of each template use :route:`templates/get_for_user`. This endpoint can't be called on a team member or admin's behalf.

    POST /2/file_properties/templates/list_for_user

  • Write

    Add property groups to a Dropbox file

    Add property groups to a Dropbox file. See :route:`templates/add_for_user` or :route:`templates/add_for_team` to create new templates.

    POST /2/file_properties/properties/add

  • Write

    Add a template associated with a team

    Add a template associated with a team. See :route:`properties/add` to add properties to a file or folder. Note: this endpoint will create team-owned templates.

    POST /2/file_properties/templates/add_for_team

  • Write

    Add a template associated with a user

    Add a template associated with a user. See :route:`properties/add` to add properties to a file. This endpoint can't be called on a team member or admin's behalf.

    POST /2/file_properties/templates/add_for_user

  • Write

    Update a template associated with a team

    Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates.

    POST /2/file_properties/templates/update_for_team

  • Write

    Update a template associated with a user

    Update a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.

    POST /2/file_properties/templates/update_for_user

  • Destructive

    Overwrite property groups associated with a file

    Overwrite property groups associated with a file. This endpoint should be used instead of :route:`properties/update` when property groups are being updated via a "snapshot" instead of via a "delta". In other words, this endpoint will delete all omitted fields from a property group, whereas :route:`properties/update` will only delete fields that are explicitly marked for deletion.

    POST /2/file_properties/properties/overwrite

  • Destructive

    Permanently removes the specified property group from the file

    Permanently removes the specified property group from the file. To remove specific property field key value pairs, see :route:`properties/update`. To update a template, see :route:`templates/update_for_user` or :route:`templates/update_for_team`. To remove a template, see :route:`templates/remove_for_user` or :route:`templates/remove_for_team`.

    POST /2/file_properties/properties/remove

  • Destructive

    Add, update or remove properties associated with the supplied file and templates

    Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of :route:`properties/overwrite` when property groups are being updated via a "delta" instead of via a "snapshot" . In other words, this endpoint will not delete any omitted fields from a property group, whereas :route:`properties/overwrite` will delete any fields that are omitted from a property group.

    POST /2/file_properties/properties/update

  • Destructive

    Permanently removes the specified template created from :route:`templates/add_for_user`

    Permanently removes the specified template created from :route:`templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.

    POST /2/file_properties/templates/remove_for_team

  • Destructive

    Permanently removes the specified template created from :route:`templates/add_for_user`

    Permanently removes the specified template created from :route:`templates/add_for_user`. All properties associated with the template will also be removed. This action cannot be undone.

    POST /2/file_properties/templates/remove_for_user

File Requests

  • Read

    Returns a list of file requests owned by this user

    Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

    POST /2/file_requests/list_v2

  • Read

    Once a cursor has been retrieved from :route:`list:2`, use this to paginate through all file requests

    Once a cursor has been retrieved from :route:`list:2`, use this to paginate through all file requests. The cursor must come from a previous call to :route:`list:2` or :route:`list/continue`.

    POST /2/file_requests/list/continue

  • Read

    Returns a list of file requests owned by this user

    Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

    POST /2/file_requests/list

  • Read

    Returns the specified file request

    Returns the specified file request.

    POST /2/file_requests/get

  • Read

    Returns the total number of file requests owned by this user

    Returns the total number of file requests owned by this user. Includes both open and closed file requests.

    POST /2/file_requests/count

  • Write

    Creates a file request for this user

    Creates a file request for this user.

    POST /2/file_requests/create

  • Destructive

    Update a file request

    Update a file request.

    POST /2/file_requests/update

  • Destructive

    Delete a batch of closed file requests

    Delete a batch of closed file requests.

    POST /2/file_requests/delete

  • Destructive

    Delete all closed file requests owned by this user

    Delete all closed file requests owned by this user.

    POST /2/file_requests/delete_all_closed

Files

  • Read

    Searches for files and folders

    Searches for files and folders. Note: :route:`search:2` along with :route:`search/continue:2` can only be used to retrieve a maximum of 10,000 matches. Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

    POST /2/files/search_v2

  • Read

    Fetches the next page of search results returned from :route:`search:2`

    Fetches the next page of search results returned from :route:`search:2`. Note: :route:`search:2` along with :route:`search/continue:2` can only be used to retrieve a maximum of 10,000 matches. Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

    POST /2/files/search/continue_v2

  • Read

    Get list of tags assigned to items

    Get list of tags assigned to items.

    POST /2/files/tags/get

  • Read

    Returns the status of an asynchronous job for :route:`create_folder_batch`

    Returns the status of an asynchronous job for :route:`create_folder_batch`. If success, it returns list of result for each entry.

    POST /2/files/create_folder_batch/check

  • Read

    Returns the status of an asynchronous job for :route:`delete_batch`

    Returns the status of an asynchronous job for :route:`delete_batch`. If success, it returns list of result for each entry.

    POST /2/files/delete_batch/check

  • Read

    Returns the status of an asynchronous job for :route:`copy_batch:1` (deprecated)

    Returns the status of an asynchronous job for :route:`copy_batch:1`. If success, it returns list of results for each entry.

    POST /2/files/copy_batch/check

  • Read

    Returns the status of an asynchronous job for :route:`copy_batch:2`

    Returns the status of an asynchronous job for :route:`copy_batch:2`. It returns list of results for each entry.

    POST /2/files/copy_batch/check_v2

  • Read

    Returns the status of an asynchronous job for :route:`move_batch:1` (deprecated)

    Returns the status of an asynchronous job for :route:`move_batch:1`. If success, it returns list of results for each entry.

    POST /2/files/move_batch/check

  • Read

    Returns the status of an asynchronous job for :route:`move_batch:2`

    Returns the status of an asynchronous job for :route:`move_batch:2`. It returns list of results for each entry.

    POST /2/files/move_batch/check_v2

  • Read

    Get a temporary link to stream content of a file

    Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.

    POST /2/files/get_temporary_link

  • Read

    Get a copy reference to a file or folder

    Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to :route:`copy_reference/save`.

    POST /2/files/copy_reference/get

  • Read

    Download a file from a user's Dropbox

    Download a file from a user's Dropbox.

    POST /2/files/download

  • Read

    Download a folder from the user's Dropbox, as a zip file

    Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size. The resulting zip must have fewer than 10,000 total file and folder entries, including the top level folder. The input cannot be a single file. Note: this endpoint does not support HTTP range requests.

    POST /2/files/download_zip

  • Read

    Export a file from a user's Dropbox

    Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose ExportResult.file_metadata has ExportInfo.export_as populated.

    POST /2/files/export

  • Read

    Return the lock metadata for the given list of paths

    Return the lock metadata for the given list of paths.

    POST /2/files/get_file_lock_batch

  • Read

    Returns the metadata for a file or folder

    Returns the metadata for a file or folder. Note: Metadata for the root folder is unsupported.

    POST /2/files/get_metadata

  • Read

    Starts returning the contents of a folder

    Starts returning the contents of a folder. If the result's :field:`ListFolderResult.has_more` field is true, call :route:`list_folder/continue` with the returned ListFolderResult.cursor to retrieve more entries. If you're using ListFolderArg.recursive set to true to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync: For each FileMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children. For each FolderMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's FolderSharingInfo.read_only and set all its children's read-only statuses to match. For each DeletedMetadata, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry. Note: auth.RateLimitError may be returned if multiple :route:`list_folder` or :route:`list_folder/continue` calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.

    POST /2/files/list_folder

  • Read

    Continue listing folder entries

    Once a cursor has been retrieved from :route:`list_folder`, use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for :route:`list_folder`.

    POST /2/files/list_folder/continue

  • Read

    A way to quickly get a cursor for the folder's state

    A way to quickly get a cursor for the folder's state. Unlike :route:`list_folder`, :route:`list_folder/get_latest_cursor` doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.

    POST /2/files/list_folder/get_latest_cursor

  • Read

    A longpoll endpoint to wait for changes on an account

    A longpoll endpoint to wait for changes on an account. In conjunction with :route:`list_folder/continue`, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps.

    POST /2/files/list_folder/longpoll

  • Read

    Returns the metadata for a file or folder (deprecated)

    Returns the metadata for a file or folder. This is an alpha endpoint compatible with the properties API. Note: Metadata for the root folder is unsupported.

    POST /2/files/alpha/get_metadata

  • Read

    Get a preview for a file

    Get a preview for a file. Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. HTML previews are generated for .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. Other formats will return an unsupported extension error.

    POST /2/files/get_preview

  • Read

    Get a thumbnail for an image

    Get a thumbnail for an image. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

    POST /2/files/get_thumbnail

  • Read

    Get thumbnails for a list of images

    Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

    POST /2/files/get_thumbnail_batch

  • Read

    Get a thumbnail for an image

    Get a thumbnail for an image. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

    POST /2/files/get_thumbnail_v2

  • Read

    Check the status of a :route:`save_url` job

    Check the status of a :route:`save_url` job.

    POST /2/files/save_url/check_job_status

  • Read

    Returns the status of an asynchronous job for :route:`upload_session/finish_batch`

    Returns the status of an asynchronous job for :route:`upload_session/finish_batch`. If success, it returns list of result for each entry.

    POST /2/files/upload_session/finish_batch/check

  • Read

    Returns revisions for files based on a file path or a file id

    Returns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately. In the ListRevisionsMode.path (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to ListRevisionsMode.id. The ListRevisionsMode.id mode is useful to retrieve revisions for a given file across moves or renames.

    POST /2/files/list_revisions

  • Read

    Searches for files and folders (deprecated)

    Searches for files and folders. Note: Recent changes will be reflected in search results within a few seconds and older revisions of existing files may still match your query for up to a few days.

    POST /2/files/search

  • Write

    Add a tag to an item

    Add a tag to an item. A tag is a string. The strings are automatically converted to lowercase letters. No more than 20 tags can be added to a given item.

    POST /2/files/tags/add

  • Write

    Create multiple folders at once

    Create multiple folders at once. This route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the CreateFolderBatchArg.force_async flag. Use :route:`create_folder_batch/check` to check the job status.

    POST /2/files/create_folder_batch

  • Write

    Copy a file or folder to a different location in the user's Dropbox (deprecated)

    Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied.

    POST /2/files/copy

  • Write

    Copy a file or folder to a different location in the user's Dropbox

    Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied.

    POST /2/files/copy_v2

  • Write

    Copy multiple files or folders to different locations at once in the user's Dropbox (deprecated)

    Copy multiple files or folders to different locations at once in the user's Dropbox. This route will return job ID immediately and do the async copy job in background. Please use :route:`copy_batch/check` to check the job status.

    POST /2/files/copy_batch

  • Write

    Copy multiple files or folders to different locations at once in the user's Dropbox

    Copy multiple files or folders to different locations at once in the user's Dropbox. This route will replace :route:`copy_batch`. The main difference is this route will return status for each entry, while :route:`copy_batch` raises failure if any entry fails. This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use :route:`copy_batch/check:2` to check the job status.

    POST /2/files/copy_batch_v2

  • Write

    Move multiple files or folders to different locations at once in the user's Dropbox (deprecated)

    Move multiple files or folders to different locations at once in the user's Dropbox. This route will return job ID immediately and do the async moving job in background. Please use :route:`move_batch/check` to check the job status.

    POST /2/files/move_batch

  • Write

    Move multiple files or folders to different locations at once in the user's Dropbox

    Move multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming. This route will replace :route:`move_batch`. The main difference is this route will return status for each entry, while :route:`move_batch` raises failure if any entry fails. This route will either finish synchronously, or return a job ID and do the async move job in background. Please use :route:`move_batch/check:2` to check the job status.

    POST /2/files/move_batch_v2

  • Write

    Create a folder at a given path (deprecated)

    Create a folder at a given path.

    POST /2/files/create_folder

  • Write

    Create a folder at a given path

    Create a folder at a given path.

    POST /2/files/create_folder_v2

  • Write

    Move a file or folder to a different location in the user's Dropbox (deprecated)

    Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved.

    POST /2/files/move

  • Write

    Move a file or folder to a different location in the user's Dropbox

    Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved. Note that we do not currently support case-only renaming.

    POST /2/files/move_v2

  • Write

    Save a copy reference returned by :route:`copy_reference/get` to the user's Dropbox

    Save a copy reference returned by :route:`copy_reference/get` to the user's Dropbox.

    POST /2/files/copy_reference/save

  • Write

    Get a one-time use temporary upload link to upload a file to a Dropbox location

    Get a one-time use temporary upload link to upload a file to a Dropbox location. This endpoint acts as a delayed upload(). The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the CommitInfo previously provided to getTemporaryUploadLink() but evaluated only upon consumption. Hence, errors stemming from invalid CommitInfo with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time. The POST request on the temporary upload link must have its Content-Type set to "application/octet-stream". Example temporary upload link consumption request: curl -X POST <temporary_upload_link_url> --header "Content-Type: application/octet-stream" --data-binary @local_file.txt A successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format. Example successful temporary upload link consumption response: {"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"} An unsuccessful temporary upload link consumption request returns any of the following status codes: HTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid. HTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened. HTTP 410 Gone: The temporary upload link is expired or consumed. Example unsuccessful temporary upload link consumption response: Temporary upload link has been recently consumed.

    POST /2/files/get_temporary_upload_link

  • Write

    Unlock the files at the given paths

    Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.

    POST /2/files/unlock_file_batch

  • Write

    Creates a new Paper doc with the provided content

    Creates a new Paper doc with the provided content.

    POST /2/files/paper/create

  • Write

    Add property groups to a Dropbox file (deprecated)

    Add property groups to a Dropbox file. See templates/add_for_user or templates/add_for_team to create new templates.

    POST /2/files/properties/add

  • Write

    Save the data from a specified URL into a file in user's Dropbox

    Save the data from a specified URL into a file in user's Dropbox. Note that the transfer from the URL must complete within 15 minutes, or the operation will time out and the job will fail.

    POST /2/files/save_url

  • Write

    Start a file upload session

    Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MiB. This call starts a new upload session with the given data. You can then use :route:`upload_session/append:2` or :route:`upload_session/append_batch` to add more data, then :route:`upload_session/finish` or :route:`upload_session/finish_batch:2` to save all the data to a file in Dropbox. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. An upload session can be used for a maximum of 7 days. Attempting to use a :field:`UploadSessionStartResult.session_id` with :route:`upload_session/append:2` or other upload session routes more than 7 days after its creation will return :field:`UploadSessionLookupError.not_found`. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit. By default, upload sessions require you to send content of the file in sequential order via consecutive :route:`upload_session/start`, :route:`upload_session/append:2`, and :route:`upload_session/finish` calls (or their batch variants). For better performance, you can optionally set :field:`UploadSessionStartArg.session_type` to :field:`UploadSessionType.concurrent` to start a concurrent upload session. Concurrent upload sessions may upload file data in concurrent :route:`upload_session/append:2` requests, with a few caveats. After all of the requests are complete, finish the session with :route:`upload_session/finish` as normal. You can not send data in a :route:`upload_session/start` or :route:`upload_session/finish` call, only with :route:`upload_session/append:2` or :route:`upload_session/append_batch`. Also, the length of the uploaded data in a call to :route:`upload_session/append:2` or :route:`upload_session/append_batch` must be a multiple of 2^22 (4,194,304) bytes, except for the final append request with :field:`UploadSessionAppendArg.close` or :field:`UploadSessionAppendBatchArgEntry.close` set to true that may contain any remaining data.

    POST /2/files/upload_session/start

  • Write

    Append more data to an upload session (deprecated)

    Append more data to an upload session. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/append

  • Write

    Append more data to an upload session

    Append more data to an upload session. When the parameter close is set, this call will close the session. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/append_v2

  • Write

    Append more data to multiple upload sessions

    Append more data to multiple upload sessions. Each piece of file content to append to each upload session should be concatenated in the request body, in the order delineated by :field:`UploadSessionAppendBatchArg.entries` and their individual lengths indicated by :field:`UploadSessionAppendBatchArgEntry.length`. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/append_batch

  • Write

    Start a batch of upload sessions

    Start a batch of upload sessions. See :route:`upload_session/start`. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/start_batch

  • Destructive

    Remove a tag from an item

    Remove a tag from an item.

    POST /2/files/tags/remove

  • Destructive

    Delete multiple files/folders at once

    Delete multiple files/folders at once. This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use :route:`delete_batch/check` to check the job status.

    POST /2/files/delete_batch

  • Destructive

    Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40)

    Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40). If the given file or folder is not yet deleted, this route will first delete it. It is possible for this route to successfully delete, then fail to permanently delete. Note: This endpoint is only available for Dropbox Business apps.

    POST /2/files/permanently_delete

  • Destructive

    Delete the file or folder at a given path (deprecated)

    Delete the file or folder at a given path. If the path is a folder, all its contents will be deleted too. A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

    POST /2/files/delete

  • Destructive

    Delete the file or folder at a given path

    Delete the file or folder at a given path. If the path is a folder, all its contents will be deleted too. A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

    POST /2/files/delete_v2

  • Destructive

    Lock the files at the given paths

    Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.

    POST /2/files/lock_file_batch

  • Destructive

    Updates an existing Paper doc with the provided content

    Updates an existing Paper doc with the provided content.

    POST /2/files/paper/update

  • Destructive

    Add, update or remove properties associated with the supplied file and templates (deprecated)

    Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of properties/overwrite when property groups are being updated via a "delta" instead of overwriting all properties of a file.

    POST /2/files/properties/update

  • Destructive

    Overwrite property groups associated with a file (deprecated)

    Overwrite property groups associated with a file. This endpoint should be used instead of properties/update when property groups are being overwritten rather than updated via a "delta".

    POST /2/files/properties/overwrite

  • Destructive

    Create a new file with the contents provided in the request

    Create a new file with the contents provided in the request. Do not use this to upload a file larger than 150 MiB. Instead, create an upload session with :route:`upload_session/start`. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload

  • Destructive

    Finish an upload session and save the uploaded data to the given file path

    Finish an upload session and save the uploaded data to the given file path. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/finish

  • Destructive

    Create a new file with the contents provided in the request (deprecated)

    Create a new file with the contents provided in the request. Note that the behavior of this alpha endpoint is unstable and subject to change. Do not use this to upload a file larger than 150 MiB. Instead, create an upload session with :route:`upload_session/start`.

    POST /2/files/alpha/upload

  • Destructive

    This route helps you commit many files at once into a user's Dropbox (deprecated)

    This route helps you commit many files at once into a user's Dropbox. Use :route:`upload_session/start` and :route:`upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling :route:`upload_session/finish`, use this route to finish all your upload sessions in a single request. :field:`UploadSessionStartArg.close` or :field:`UploadSessionAppendArg.close` needs to be true for the last :route:`upload_session/start` or :route:`upload_session/append:2` call. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. This route will return a job_id immediately and do the async commit job in background. Use :route:`upload_session/finish_batch/check` to check the job status. For the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/finish_batch

  • Destructive

    This route helps you commit many files at once into a user's Dropbox

    This route helps you commit many files at once into a user's Dropbox. Use :route:`upload_session/start` and :route:`upload_session/append:2` to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling :route:`upload_session/finish`, use this route to finish all your upload sessions in a single request. :field:`UploadSessionStartArg.close` or :field:`UploadSessionAppendArg.close` needs to be true for the last :route:`upload_session/start` or :route:`upload_session/append:2` call of each upload session. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes. We allow up to 1000 entries in a single request. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page https://www.dropbox.com/developers/reference/data-transport-limit.

    POST /2/files/upload_session/finish_batch_v2

  • Destructive

    Restore a specific revision of a file to the given path

    Restore a specific revision of a file to the given path.

    POST /2/files/restore

Openid

  • Read

    This route is used for refreshing the info that is found in the id_token during the OIDC flow

    This route is used for refreshing the info that is found in the id_token during the OIDC flow. This route doesn't require any arguments and will use the scopes approved for the given access token.

    POST /2/openid/userinfo

Paper

  • Read

    Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained (deprecated)

    Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained. For private folders all users (including owner) shared on the folder are listed and for team folders all non-team users shared on the folder are returned. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/folder_users/list

  • Read

    Once a cursor has been retrieved from :route:`docs/folder_users/list`, use this to paginate through all users on the Paper folder (deprecated)

    Once a cursor has been retrieved from :route:`docs/folder_users/list`, use this to paginate through all users on the Paper folder. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/folder_users/list/continue

  • Read

    Gets the default sharing policy for the given Paper doc (deprecated)

    Gets the default sharing policy for the given Paper doc. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/sharing_policy/get

  • Read

    Exports and downloads Paper doc either as HTML or markdown (deprecated)

    Exports and downloads Paper doc either as HTML or markdown. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/download

  • Read

    Retrieves folder information for the given Paper doc (deprecated)

    Retrieves folder information for the given Paper doc. This includes: - folder sharing policy; permissions for subfolders are set by the top-level folder. - full 'filepath', i.e. the list of folders (both folderId and folderName) from the root folder to the folder directly containing the Paper doc. If the Paper doc is not in any folder (aka unfiled) the response will be empty. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/get_folder_info

  • Read

    Lists all users who visited the Paper doc or users with explicit access (deprecated)

    Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed. The list is sorted by the date of the visit or the share date. The list will include both users, the explicitly shared ones as well as those who came in using the Paper url link. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/users/list

  • Read

    Once a cursor has been retrieved from :route:`docs/users/list`, use this to paginate through all users on the Paper doc (deprecated)

    Once a cursor has been retrieved from :route:`docs/users/list`, use this to paginate through all users on the Paper doc. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/users/list/continue

  • Read

    Return the list of all Paper docs according to the argument specifications (deprecated)

    Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to :route:`docs/list/continue`. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/list

  • Read

    Once a cursor has been retrieved from :route:`docs/list`, use this to paginate through all Paper doc (deprecated)

    Once a cursor has been retrieved from :route:`docs/list`, use this to paginate through all Paper doc. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/list/continue

  • Read

    Returns metadata for a Paper doc or Cloud Doc

    Returns metadata for a Paper doc or Cloud Doc.

    POST /2/paper/docs/get_metadata

  • Write

    Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID (deprecated)

    Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID. The doc owner's permissions cannot be changed. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/users/add

  • Write

    Creates a new Paper doc with the provided content (deprecated)

    Creates a new Paper doc with the provided content. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. This endpoint will be retired in September 2020. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for more information.

    POST /2/paper/docs/create

  • Write

    Create a new Paper folder with the provided info (deprecated)

    Create a new Paper folder with the provided info. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/folders/create

  • Destructive

    Sets the default sharing policy for the given Paper doc (deprecated)

    Sets the default sharing policy for the given Paper doc. The default 'team_sharing_policy' can be changed only by teams, omit this field for personal accounts. The 'public_sharing_policy' policy can't be set to the value 'disabled' because this setting can be changed only via the team admin console. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/sharing_policy/set

  • Destructive

    Marks the given Paper doc as archived (deprecated)

    Marks the given Paper doc as archived. This action can be performed or undone by anyone with edit permissions to the doc. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. This endpoint will be retired in September 2020. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for more information.

    POST /2/paper/docs/archive

  • Destructive

    Permanently deletes the given Paper doc (deprecated)

    Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered. This action can be performed only by the doc owner. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/permanently_delete

  • Destructive

    Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID (deprecated)

    Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID. The doc owner cannot be removed. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for migration information.

    POST /2/paper/docs/users/remove

  • Destructive

    Updates an existing Paper doc with the provided content (deprecated)

    Updates an existing Paper doc with the provided content. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. This endpoint will be retired in September 2020. Refer to the :link:`Paper Migration Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide` for more information.

    POST /2/paper/docs/update

Riviera

  • Read

    Download the output of a completed `get_transform_async` job

    Download the output of a completed `get_transform_async` job. Pass the `output_handle` from the job's `complete` result. The body is the produced file, and the `Dropbox-API-Result` header describes it. A handle can only be redeemed by the user who requested the transform, and only until its `expires_ts`; after that this route fails with `expired_handle_error`, and the transform has to be requested again. A handle that was never valid, or that belongs to another user, fails with `user_error`.

    POST /2/riviera/download_transform_output

  • Read

    Returns the status or result of specified get_transform_async task

    Returns the status or result of specified get_transform_async task.

    POST /2/riviera/get_transform_async/check

  • Read

    Returns the status or result of specified get_transcript_async task

    Returns the status or result of specified get_transcript_async task.

    POST /2/riviera/get_transcript_async/check

  • Read

    Returns the status or result of specified get_keyframes_async task

    Returns the status or result of specified get_keyframes_async task.

    POST /2/riviera/get_keyframes_async/check

  • Read

    Returns the status or result of specified get_markdown_async task

    Returns the status or result of specified get_markdown_async task.

    POST /2/riviera/get_markdown_async/check

  • Read

    Returns the status or result of specified get_metadata_async task

    Returns the status or result of specified get_metadata_async task.

    POST /2/riviera/get_metadata_async/check

  • Read

    Returns the status or result of specified get_ocr_async task

    Returns the status or result of specified get_ocr_async task.

    POST /2/riviera/get_ocr_async/check

  • Read

    Returns the status or result of specified get_text_async task

    Returns the status or result of specified get_text_async task.

    POST /2/riviera/get_text_async/check

  • Write

    Asynchronous file transformation: produces a new file from an existing one

    Asynchronous file transformation: produces a new file from an existing one. One route covers many conversions. Name the source file in `file_id_or_url`, say what you want back in `transform_type`, and supply that type's options message if it needs one: - `pdf`: documents and images, to PDF. - `html`: spreadsheets, to HTML, preserving the sheet layout. - `image`: images and single document pages, to JPEG or PNG. - `thumbnail`: any thumbnailable source, resized to a named size bucket. - `image_pdf`: documents, to a page image rendered by way of PDF. - `video_frame`: one still frame from a video, at a requested offset. The accepted input formats differ per transform -- they are not one shared list -- and each is the intersection of the source format with the pipeline that transform uses: - `pdf` and `image_pdf`: word-processing, presentation and spreadsheet documents (.doc, .docx, .ppt, .pptx, .xls, .xlsx, .odt, .odp, .ods, .rtf, .epub, .gdoc, .gslides, .hwp, .ai, .eps, .dwg among others). Images are not accepted. - `html`: spreadsheets only -- .xls, .xlsm, .xlsx, .ods, .gsheet. This is the complete list. Note that .csv and .txt are *not* accepted here. - `image`: the documents above, plus .pdf and .html, plus the iWork and design formats .pages, .key, .numbers, .sketch, .xd, .indd and .psd, plus .avif, .heic, .svg and camera RAW, plus fonts (.otf, .ttf), plus video. Formats a browser can already display (.bmp, .gif, .ico, .jpeg, .png, .tif, .tiff, .webp) are not accepted; use `thumbnail` for those. - `thumbnail`: everything `image` accepts, plus .bmp, .gif, .ico, .jpeg, .png, .tif, .tiff, .webp and JPEG 2000. - `video_frame`: .3g2, .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .ogv, .rm, .ts, .vob, .webm, .wmv. This is the complete list. These lists track Riviera's capability registry (`dropbox/riviera/supported_types/previews_supported_types.yaml`), which is generated and authoritative; treat it rather than this comment as the final word. Formats the requested transform does not support fail with `unsupported_format_error`. Options belonging to a different transform type than the one requested fail with `invalid_options_error`. The produced bytes are not returned by this route, and not by its `/check` poll either. Poll `get_transform_async/check` with the returned async job ID until it reports `complete` or `failed`; a `complete` result carries a `TransformOutput` whose `output_handle` `download_transform_output` exchanges for the bytes. Splitting retrieval out this way is what lets the route return outputs larger than an async result can carry.

    POST /2/riviera/get_transform_async

  • Write

    Asynchronous transcript generation for audio and video files

    Asynchronous transcript generation for audio and video files. Supported audio formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Files in other formats fail with :field:`ContentApiV2Error.user_error`. Size limits: the source file must be at most 10 GB and its audio track at most 1 hour in duration. Files exceeding either limit fail with :field:`ContentApiV2Error.user_error`. The transcript is not returned by this route. Poll :route:`get_transcript_async/check` with the returned async job ID until it reports :field:`GetTranscriptAsyncCheckResult.complete` or :field:`GetTranscriptAsyncCheckResult.failed`.

    POST /2/riviera/get_transcript_async

  • Write

    Asynchronous scene-change keyframe extraction for video files

    Asynchronous scene-change keyframe extraction for video files. Detects scene changes in the source video and returns one representative keyframe per detected scene, each tagged with its timestamp (seconds from the start of the video) and scene-change score. Set `include_images = true` to also receive each frame as a base64-encoded JPEG; when the field is omitted the response carries keyframe metadata only. Supported video formats: .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. Unsupported formats return an `unsupported_format_error`. Limits: the source file must be at most 10 GB. To keep responses within service limits the number of keyframes and the total image payload are bounded; requests that would exceed these limits return a `limit_exceeded_error` -- raise `scene_change_threshold` or set `include_images = false` to stay within bounds.

    POST /2/riviera/get_keyframes_async

  • Write

    Asynchronous document-to-markdown conversion for supported file formats

    Asynchronous document-to-markdown conversion for supported file formats. Supported formats: .binder, .docx, .html, .paper, .papert, .pptx, .xlsx, .gsheet, .ods, .pdf. Files in other formats fail with :field:`MarkdownConversionApiV2Error.user_error`. Size limit: the source file must be at most 50 MB. Larger files fail with :field:`MarkdownConversionApiV2Error.user_error`. The markdown is not returned by this route. Poll :route:`get_markdown_async/check` with the returned async job ID until it reports :field:`GetMarkdownAsyncCheckResult.complete` or :field:`GetMarkdownAsyncCheckResult.failed`.

    POST /2/riviera/get_markdown_async

  • Write

    Asynchronous file metadata extraction for supported file formats

    Asynchronous file metadata extraction for supported file formats. The kind of metadata returned depends on the file type: - Image (EXIF) formats: .3fr, .arw, .avif, .bmp, .cr2, .cr3, .crw, .dcr, .dcs, .dng, .erf, .gif, .heic, .j2c, .j2k, .jp2, .jpc, .jpeg, .jpf, .jpg, .jpg2, .jpm, .jpx, .kdc, .mef, .mos, .mrw, .nef, .nrw, .orf, .pef, .png, .ppm, .r3d, .raf, .rw2, .rwl, .sr2, .tga, .tif, .tiff, .wbmp, .web, .webp, .x3f. - Audio/video (media) formats: .aac, .aif, .aiff, .flac, .m4a, .m4r, .mp3, .oga, .ogg, .wav, .wma, .3gp, .3gpp, .3gpp2, .asf, .avi, .dv, .flv, .m2t, .m2ts, .m4v, .mkv, .mov, .mp4, .mpeg, .mpg, .mts, .mxf, .oggtheora, .ogv, .rm, .ts, .vob, .webm, .wmv. - PDF format: .pdf. - MS Office formats: .docx, .pptx, .xlsx. Files in other formats fail with :field:`MetadataExtractionApiV2Error.user_error`. Size limits depend on the kind of metadata being extracted: at most 200 MB for image (EXIF) files, 100 GB for audio/video files, 500 MB for PDFs, and 288 MB for MS Office files. Files over the limit for their kind fail with :field:`MetadataExtractionApiV2Error.user_error`. The metadata is not returned by this route. Poll :route:`get_metadata_async/check` with the returned async job ID until it reports :field:`GetMetadataAsyncCheckResult.complete` or :field:`GetMetadataAsyncCheckResult.failed`.

    POST /2/riviera/get_metadata_async

  • Write

    Asynchronous OCR (optical character recognition) text extraction for images and PDFs, including scanned / non-text PDFs

    Asynchronous OCR (optical character recognition) text extraction for images and PDFs, including scanned / non-text PDFs. Supported formats: - Image formats: .bmp, .gif, .heic, .jpeg, .jpg, .png, .tif, .tiff, .webp. - PDF format: .pdf. Unsupported formats return an `unsupported_format_error`. For the `url` variant only Dropbox shared links are supported; external URLs return `unsupported_format_error`. Text-based PDFs already carry a text layer, so OCR is not run against them and the result is empty; use `get_text_async` to read the embedded text layer of such a PDF. The result carries the extracted words as plain text, plus the same content as hOCR with per-word coordinates.

    POST /2/riviera/get_ocr_async

  • Write

    Asynchronous plain-text extraction from documents

    Asynchronous plain-text extraction from documents. Supported formats include: - Word processing: .doc, .docx, .docm, .rtf. - Presentations: .ppt, .pptx, .pptm. - Spreadsheets: .xls, .xlsx, .xlsm. - PDF: .pdf. - Dropbox document types: .paper, .papert, .binder, .gdoc, .gsheet, .gslides. - Plain text / subtitles: .txt, .vtt. Unsupported formats return an `unsupported_format_error`. For the `url` variant only Dropbox shared links are supported; external URLs return `unsupported_format_error`.

    POST /2/riviera/get_text_async

Sharing

  • Read

    Returns shared file metadata

    Returns shared file metadata.

    POST /2/sharing/get_file_metadata

  • Read

    Use to obtain the members who have been invited to a file, both inherited and uninherited members

    Use to obtain the members who have been invited to a file, both inherited and uninherited members.

    POST /2/sharing/list_file_members

  • Read

    List shared links of this user

    List shared links of this user. If no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member's home folder unless the team space ID is specified in the request header. If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.

    POST /2/sharing/list_shared_links

  • Read

    Download the shared link's file from a user's Dropbox

    Download the shared link's file from a user's Dropbox. This is a download-style endpoint that returns the file content.

    POST /2/sharing/get_shared_link_file

  • Read

    Get the shared link's metadata

    Get the shared link's metadata.

    POST /2/sharing/get_shared_link_metadata

  • Read

    DEPRECATED: Use list_shared_links instead (deprecated)

    DEPRECATED: Use list_shared_links instead. This endpoint will be retired in October 2026. Returns a list of :type:`LinkMetadata` objects for this user, including collection links. If no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links. If a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.

    POST /2/sharing/get_shared_links

  • Read

    Get members of multiple files at once

    Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint. Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.

    POST /2/sharing/list_file_members/batch

  • Read

    Returns shared file metadata

    Returns shared file metadata.

    POST /2/sharing/get_file_metadata/batch

  • Read

    Continue listing shared-file members

    Once a cursor has been retrieved from :route:`list_file_members` or :route:`list_file_members/batch`, use this to paginate through all shared file members.

    POST /2/sharing/list_file_members/continue

  • Read

    Returns a list of all files shared with current user

    Returns a list of all files shared with current user.

    POST /2/sharing/list_received_files

  • Read

    Get more results with a cursor from :route:`list_received_files`

    Get more results with a cursor from :route:`list_received_files`.

    POST /2/sharing/list_received_files/continue

  • Read

    Returns the status of an asynchronous job

    Returns the status of an asynchronous job.

    POST /2/sharing/check_job_status

  • Read

    Returns the status of an asynchronous job for sharing a folder

    Returns the status of an asynchronous job for sharing a folder.

    POST /2/sharing/check_remove_member_job_status

  • Read

    Returns the status of an asynchronous job for sharing a folder

    Returns the status of an asynchronous job for sharing a folder.

    POST /2/sharing/check_share_job_status

  • Read

    Once a cursor has been retrieved from :route:`list_folder_members`, use this to paginate through all shared folder members

    Once a cursor has been retrieved from :route:`list_folder_members`, use this to paginate through all shared folder members.

    POST /2/sharing/list_folder_members/continue

  • Read

    Return the list of all shared folders the current user has access to

    Return the list of all shared folders the current user has access to.

    POST /2/sharing/list_folders

  • Read

    Once a cursor has been retrieved from :route:`list_folders`, use this to paginate through all shared folders

    Once a cursor has been retrieved from :route:`list_folders`, use this to paginate through all shared folders. The cursor must come from a previous call to :route:`list_folders` or :route:`list_folders/continue`.

    POST /2/sharing/list_folders/continue

  • Read

    Once a cursor has been retrieved from :route:`list_mountable_folders`, use this to paginate through all mountable shared folders

    Once a cursor has been retrieved from :route:`list_mountable_folders`, use this to paginate through all mountable shared folders. The cursor must come from a previous call to :route:`list_mountable_folders` or :route:`list_mountable_folders/continue`.

    POST /2/sharing/list_mountable_folders/continue

  • Read

    Returns shared folder metadata by its folder ID

    Returns shared folder metadata by its folder ID.

    POST /2/sharing/get_folder_metadata

  • Read

    Returns shared folder membership by its folder ID

    Returns shared folder membership by its folder ID.

    POST /2/sharing/list_folder_members

  • Read

    Return the list of all shared folders the current user can mount or unmount

    Return the list of all shared folders the current user can mount or unmount.

    POST /2/sharing/list_mountable_folders

  • Write

    Create a shared link with custom settings

    Create a shared link with custom settings. If no settings are given then the default visibility is RequestedVisibility.public (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).

    POST /2/sharing/create_shared_link_with_settings

  • Write

    Create a shared link (deprecated)

    Create a shared link. If a shared link already exists for the given path, that link is returned. Previously, it was technically possible to break a shared link by moving or renaming the corresponding file or folder. In the future, this will no longer be the case, so your app shouldn't rely on this behavior. Instead, if your app needs to revoke a shared link, use revoke_shared_link. DEPRECATED: Use create_shared_link_with_settings instead.

    POST /2/sharing/create_shared_link

  • Write

    Adds specified members to a file

    Adds specified members to a file.

    POST /2/sharing/add_file_member

  • Write

    Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member

    Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member. For the new member to get access to all the functionality for this folder, you will need to call :route:`mount_folder` on their behalf.

    POST /2/sharing/add_folder_member

  • Write

    The current user mounts the designated folder

    The current user mounts the designated folder. Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.

    POST /2/sharing/mount_folder

  • Write

    Share a folder with collaborators

    Share a folder with collaborators. Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set `ShareFolderArg.force_async`. If a :field:`ShareFolderLaunch.async_job_id` is returned, you'll need to call :route:`check_share_job_status` until the action completes to get the metadata for the folder.

    POST /2/sharing/share_folder

  • Destructive

    Modify the shared link's settings

    Modify the shared link's settings. If the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the LinkPermissions.resolved_visibility of the returned SharedLinkMetadata will reflect the actual visibility of the shared link and the LinkPermissions.requested_visibility will reflect the requested visibility.

    POST /2/sharing/modify_shared_link_settings

  • Destructive

    Revoke a shared link

    Revoke a shared link. Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the list_shared_links with the file as the ListSharedLinksArg.path argument.

    POST /2/sharing/revoke_shared_link

  • Destructive

    Removes a specified member from the file

    Removes a specified member from the file.

    POST /2/sharing/remove_file_member_2

  • Destructive

    The current user relinquishes their membership in the designated file

    The current user relinquishes their membership in the designated file.

    POST /2/sharing/relinquish_file_membership

  • Destructive

    Removes all self-removable access from a file or folder for the current user

    Removes all self-removable access from a file or folder for the current user. Best-effort and idempotent: attempts to drop link-visitor associations and explicit ACL membership.

    POST /2/sharing/relinquish_access

  • Destructive

    Remove all members from this file

    Remove all members from this file. Does not remove inherited members.

    POST /2/sharing/unshare_file

  • Destructive

    Changes a member's access on a shared file

    Changes a member's access on a shared file.

    POST /2/sharing/update_file_member

  • Destructive

    Update the viewer info policy of a file

    Update the viewer info policy of a file.

    POST /2/sharing/update_file_policy

  • Destructive

    The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder

    The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder. This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.

    POST /2/sharing/relinquish_folder_membership

  • Destructive

    Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member

    Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.

    POST /2/sharing/remove_folder_member

  • Destructive

    Change the inheritance policy of an existing Shared Folder

    Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root. If a :field:`ShareFolderLaunch.async_job_id` is returned, you'll need to call :route:`check_share_job_status` until the action completes to get the metadata for the folder.

    POST /2/sharing/set_access_inheritance

  • Destructive

    Transfer ownership of a shared folder to a member of the shared folder

    Transfer ownership of a shared folder to a member of the shared folder. User must have :field:`AccessLevel.owner` access to the shared folder to perform a transfer.

    POST /2/sharing/transfer_folder

  • Destructive

    The current user unmounts the designated folder

    The current user unmounts the designated folder. They can re-mount the folder at a later time using :route:`mount_folder`.

    POST /2/sharing/unmount_folder

  • Destructive

    Allows a shared folder owner to unshare the folder

    Allows a shared folder owner to unshare the folder. Unshare will not work in following cases: The shared folder contains shared folders OR the shared folder is inside another shared folder. You'll need to call :route:`check_job_status` to determine if the action has completed successfully.

    POST /2/sharing/unshare_folder

  • Destructive

    Allows an owner or editor of a shared folder to update another member's permissions

    Allows an owner or editor of a shared folder to update another member's permissions.

    POST /2/sharing/update_folder_member

  • Destructive

    Update the sharing policies for a shared folder

    Update the sharing policies for a shared folder. User must have :field:`AccessLevel.owner` access to the shared folder to update its policies.

    POST /2/sharing/update_folder_policy

Team

  • Read

    Poll a previously launched member suspension batch job

    Poll a previously launched member suspension batch job.

    POST /2/team/members/suspend_batch/job_status/check

  • Read

    List all device sessions of a team's member

    List all device sessions of a team's member.

    POST /2/team/devices/list_member_devices

  • Read

    List all device sessions of a team

    List all device sessions of a team. Permission : Team member file access.

    POST /2/team/devices/list_members_devices

  • Read

    List all device sessions of a team (deprecated)

    List all device sessions of a team. Permission : Team member file access.

    POST /2/team/devices/list_team_devices

  • Read

    Lists all team folders

    Lists all team folders. Permission : Team member file access.

    POST /2/team/team_folder/list

  • Read

    Once a cursor has been retrieved from :route:`team_folder/list`, use this to paginate through all team folders

    Once a cursor has been retrieved from :route:`team_folder/list`, use this to paginate through all team folders. Permission : Team member file access.

    POST /2/team/team_folder/list/continue

  • Read

    Retrieves metadata for team folders

    Retrieves metadata for team folders. Permission : Team member file access.

    POST /2/team/team_folder/get_info

  • Read

    Returns the status of an asynchronous job for archiving a team folder

    Returns the status of an asynchronous job for archiving a team folder. The job may show '.tag' as complete, but the team folder could still be in the process of archiving (indicated by :field:`TeamFolderMetadata.status` with 'archive_in_progress'). To confirm that the team folder is fully archived, check the field :field:`TeamFolderMetadata.status` in the response for the value 'archived'. Permission : Team member file access.

    POST /2/team/team_folder/archive/check

  • Read

    Gets a legal hold by Id

    Gets a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/get_policy

  • Read

    Lists legal holds on a team

    Lists legal holds on a team. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/list_policies

  • Read

    List the file metadata that's under the hold

    List the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/list_held_revisions

  • Read

    Continue listing the file metadata that's under the hold

    Continue listing the file metadata that's under the hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/list_held_revisions_continue

  • Read

    Get available TeamMemberRoles for the connected team

    Get available TeamMemberRoles for the connected team. To be used with :route:`members/set_admin_permissions:2`. Permission : Team member management.

    POST /2/team/members/get_available_team_member_roles

  • Read

    Returns information about multiple team members

    Returns information about multiple team members. Permission : Team information This endpoint will return :field:`MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member.

    POST /2/team/members/get_info

  • Read

    Returns information about multiple team members

    Returns information about multiple team members. Permission : Team information This endpoint will return :field:`MembersGetInfoItem.id_not_found`, for IDs (or emails) that cannot be matched to a valid team member.

    POST /2/team/members/get_info_v2

  • Read

    Lists members of a team

    Lists members of a team. Permission : Team information.

    POST /2/team/members/list

  • Read

    Once a cursor has been retrieved from :route:`members/list`, use this to paginate through all team members

    Once a cursor has been retrieved from :route:`members/list`, use this to paginate through all team members. Permission : Team information.

    POST /2/team/members/list/continue

  • Read

    Once a cursor has been retrieved from :route:`members/list:2`, use this to paginate through all team members

    Once a cursor has been retrieved from :route:`members/list:2`, use this to paginate through all team members. Permission : Team information.

    POST /2/team/members/list/continue_v2

  • Read

    Lists members of a team

    Lists members of a team. Permission : Team information.

    POST /2/team/members/list_v2

  • Read

    Check former-member file-move job status

    Once an async_job_id is returned from :route:`members/move_former_member_files` , use this to poll the status of the asynchronous request. Permission : Team member management.

    POST /2/team/members/move_former_member_files/job_status/check

  • Read

    Once an async_job_id is returned from :route:`members/remove` , use this to poll the status of the asynchronous request

    Once an async_job_id is returned from :route:`members/remove` , use this to poll the status of the asynchronous request. Permission : Team member management.

    POST /2/team/members/remove/job_status/get

  • Read

    Once an async_job_id is returned from :route:`members/add` , use this to poll the status of the asynchronous request

    Once an async_job_id is returned from :route:`members/add` , use this to poll the status of the asynchronous request. Permission : Team member management.

    POST /2/team/members/add/job_status/get

  • Read

    Once an async_job_id is returned from :route:`members/add:2` , use this to poll the status of the asynchronous request

    Once an async_job_id is returned from :route:`members/add:2` , use this to poll the status of the asynchronous request. Permission : Team member management.

    POST /2/team/members/add/job_status/get_v2

  • Read

    Get the values for one or more features

    Get the values for one or more features. This route allows you to check your account's capability for what feature you can access or what value you have for certain features. Permission : Team information.

    POST /2/team/features/get_values

  • Read

    Retrieves information about a team

    Retrieves information about a team.

    POST /2/team/get_info

  • Read

    Returns the member profile of the admin who generated the team access token used to make the call

    Returns the member profile of the admin who generated the team access token used to make the call.

    POST /2/team/token/get_authenticated_admin

  • Read

    Get a team file-property template (deprecated)

    Get a team file-property template. Permission : Team member file access. The scope for the route is files.team_metadata.write.

    POST /2/team/properties/template/get

  • Read

    Lists groups on a team

    Lists groups on a team. Permission : Team Information.

    POST /2/team/groups/list

  • Read

    Once a cursor has been retrieved from :route:`groups/list`, use this to paginate through all groups

    Once a cursor has been retrieved from :route:`groups/list`, use this to paginate through all groups. Permission : Team Information.

    POST /2/team/groups/list/continue

  • Read

    Retrieves information about one or more groups

    Retrieves information about one or more groups. Note that the optional field :field:`GroupFullInfo.members` is not returned for system-managed groups. Permission : Team Information.

    POST /2/team/groups/get_info

  • Read

    Lists members of a group

    Lists members of a group. Permission : Team Information.

    POST /2/team/groups/members/list

  • Read

    Once a cursor has been retrieved from :route:`groups/members/list`, use this to paginate through all members of the group

    Once a cursor has been retrieved from :route:`groups/members/list`, use this to paginate through all members of the group. Permission : Team information.

    POST /2/team/groups/members/list/continue

  • Read

    Get group-operation job status

    Once an async_job_id is returned from :route:`groups/delete`, :route:`groups/members/add` , or :route:`groups/members/remove` use this method to poll the status of granting/revoking group members' access to group-owned resources. Permission : Team member management.

    POST /2/team/groups/job_status/get

  • Read

    List all linked applications of the team member

    List all linked applications of the team member. Note, this endpoint does not list any team-linked applications.

    POST /2/team/linked_apps/list_member_linked_apps

  • Read

    List all applications linked to the team members' accounts

    List all applications linked to the team members' accounts. Note, this endpoint does not list any team-linked applications.

    POST /2/team/linked_apps/list_members_linked_apps

  • Read

    List all applications linked to the team members' accounts (deprecated)

    List all applications linked to the team members' accounts. Note, this endpoint doesn't list any team-linked applications.

    POST /2/team/linked_apps/list_team_linked_apps

  • Read

    Get users custom quota

    Get users custom quota. A maximum of 1000 members can be specified in a single call. Note: to apply a custom space limit, a team admin needs to set a member space limit for the team first. (the team admin can check the settings here: https://www.dropbox.com/team/admin/settings/space).

    POST /2/team/member_space_limits/get_custom_quota

  • Read

    List member space limits excluded users

    List member space limits excluded users.

    POST /2/team/member_space_limits/excluded_users/list

  • Read

    Continue listing member space limits excluded users

    Continue listing member space limits excluded users.

    POST /2/team/member_space_limits/excluded_users/list/continue

  • Read

    Returns a list of all team-accessible namespaces

    Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.

    POST /2/team/namespaces/list

  • Read

    Once a cursor has been retrieved from :route:`namespaces/list`, use this to paginate through all team-accessible namespaces

    Once a cursor has been retrieved from :route:`namespaces/list`, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.

    POST /2/team/namespaces/list/continue

  • Read

    Retrieves reporting data about a team's user activity (deprecated)

    Retrieves reporting data about a team's user activity. Deprecated: Will be removed on July 1st 2021.

    POST /2/team/reports/get_activity

  • Read

    Retrieves reporting data about a team's storage usage (deprecated)

    Retrieves reporting data about a team's storage usage. Deprecated: Will be removed on July 1st 2021.

    POST /2/team/reports/get_storage

  • Read

    Retrieves reporting data about a team's linked devices (deprecated)

    Retrieves reporting data about a team's linked devices. Deprecated: Will be removed on July 1st 2021.

    POST /2/team/reports/get_devices

  • Read

    Retrieves reporting data about a team's membership (deprecated)

    Retrieves reporting data about a team's membership. Deprecated: Will be removed on July 1st 2021.

    POST /2/team/reports/get_membership

  • Write

    Creates a new, active, team folder with no members

    Creates a new, active, team folder with no members. This endpoint can only be used for teams that do not already have a shared team space. Permission : Team member file access.

    POST /2/team/team_folder/create

  • Write

    Changes an active team folder's name

    Changes an active team folder's name. Permission : Team member file access.

    POST /2/team/team_folder/rename

  • Write

    Sets an archived team folder's status to active

    Sets an archived team folder's status to active. Permission : Team member file access.

    POST /2/team/team_folder/activate

  • Write

    Sets an inactive team folder's status to active

    Sets an inactive team folder's status to active. Permission: Team member file access.

    POST /2/team/team_folder/restore

  • Write

    Updates the sync settings on a team folder or its contents

    Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.

    POST /2/team/team_folder/update_sync_settings

  • Write

    Creates new legal hold policy

    Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/create_policy

  • Write

    Updates a legal hold

    Updates a legal hold. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/update_policy

  • Write

    Moves removed member's files to a different member

    Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll :route:`members/move_former_member_files/job_status/check`. Permission : Team member management.

    POST /2/team/members/move_former_member_files

  • Write

    Unsuspend a member from a team

    Unsuspend a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    POST /2/team/members/unsuspend

  • Write

    Updates a team member's profile

    Updates a team member's profile. Permission : Team member management.

    POST /2/team/members/set_profile

  • Write

    Updates a team member's profile

    Updates a team member's profile. Permission : Team member management.

    POST /2/team/members/set_profile_v2

  • Write

    Updates a team member's profile photo

    Updates a team member's profile photo. Permission : Team member management.

    POST /2/team/members/set_profile_photo

  • Write

    Updates a team member's profile photo

    Updates a team member's profile photo. Permission : Team member management.

    POST /2/team/members/set_profile_photo_v2

  • Write

    Recover a deleted member

    Recover a deleted member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    POST /2/team/members/recover

  • Write

    Adds members to a team

    Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team. Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.

    POST /2/team/members/add

  • Write

    Adds members to a team

    Adds members to a team. Permission : Team member management A maximum of 20 members can be specified in a single call. If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team. If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.

    POST /2/team/members/add_v2

  • Write

    Sends welcome email to pending team member

    Sends welcome email to pending team member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. No-op if team member is not pending.

    POST /2/team/members/send_welcome_email

  • Write

    Add a team file-property template (deprecated)

    Add a team file-property template. Permission : Team member file access.

    POST /2/team/properties/template/add

  • Write

    Creates a new, empty group, with a requested name

    Creates a new, empty group, with a requested name. Permission : Team member management.

    POST /2/team/groups/create

  • Write

    Updates a group's name and/or external ID

    Updates a group's name and/or external ID. Permission : Team member management.

    POST /2/team/groups/update

  • Write

    Adds members to a group

    Adds members to a group. The members are added immediately. However the granting of group-owned resources may take additional time. Use the :route:`groups/job_status/get` to determine whether this process has completed. Permission : Team member management.

    POST /2/team/groups/members/add

  • Write

    Set users custom quota

    Set users custom quota. Custom quota has to be at least 2GB. A maximum of 1000 members can be specified in a single call. Note: to apply a custom space limit, a team admin needs to set a member space limit for the team first. (the team admin can check the settings here: https://www.dropbox.com/team/admin/settings/space).

    POST /2/team/member_space_limits/set_custom_quota

  • Write

    Remove users custom quota

    Remove users custom quota. A maximum of 1000 members can be specified in a single call. Note: to apply a custom space limit, a team admin needs to set a member space limit for the team first. (the team admin can check the settings here: https://www.dropbox.com/team/admin/settings/space).

    POST /2/team/member_space_limits/remove_custom_quota

  • Write

    Add users to member space limits excluded users list

    Add users to member space limits excluded users list.

    POST /2/team/member_space_limits/excluded_users/add

  • Write

    Remove users from member space limits excluded users list

    Remove users from member space limits excluded users list.

    POST /2/team/member_space_limits/excluded_users/remove

  • Write

    Add secondary emails to users

    Add secondary emails to users. Permission : Team member management. Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.

    POST /2/team/members/secondary_emails/add

  • Write

    Resend secondary email verification emails

    Resend secondary email verification emails. Permission : Team member management.

    POST /2/team/members/secondary_emails/resend_verification_emails

  • Destructive

    Launch a member suspension batch

    Launch a member suspension batch. The server enforces a maximum of 500 members.

    POST /2/team/members/suspend_batch

  • Destructive

    Revoke a device session of a team's member

    Revoke a device session of a team's member.

    POST /2/team/devices/revoke_device_session

  • Destructive

    Revoke a list of device sessions of team members

    Revoke a list of device sessions of team members.

    POST /2/team/devices/revoke_device_session_batch

  • Destructive

    Sets an active team folder's status to archived and removes all folder and file members

    Sets an active team folder's status to archived and removes all folder and file members. This endpoint cannot be used for teams that have a shared team space. This route will either finish synchronously, or return a job ID and do the async archive job in background. Please use team_folder/archive/check to check the job status. Permission : Team member file access.

    POST /2/team/team_folder/archive

  • Destructive

    Permanently deletes an archived team folder

    Permanently deletes an archived team folder. This endpoint cannot be used for teams that have a shared team space. Permission : Team member file access.

    POST /2/team/team_folder/permanently_delete

  • Destructive

    Releases a legal hold by Id

    Releases a legal hold by Id. Note: Legal Holds is a paid add-on. Not all teams have the feature. Permission : Team member file access.

    POST /2/team/legal_holds/release_policy

  • Destructive

    Permanently delete the files of a user who has been removed from the team

    Permanently delete the files of a user who has been removed from the team. After permanent deletion, those files will not be available to be transferred to another team member. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    POST /2/team/members/delete_former_member_files

  • Destructive

    Removes a member from a team

    Removes a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account. Accounts can be recovered via :route:`members/recover` for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling :route:`members/add` while a user is still recoverable on your team will return with :field:`MemberAddResult.user_already_on_team`. Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (180 days for most teams). Accounts can have their stacks transferred through the admin console. This only transfers stacks that they have created. This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll :route:`members/remove/job_status/get`.

    POST /2/team/members/remove

  • Destructive

    Updates a team member's permissions

    Updates a team member's permissions. Permission : Team member management.

    POST /2/team/members/set_admin_permissions

  • Destructive

    Updates a team member's permissions

    Updates a team member's permissions. Permission : Team member management.

    POST /2/team/members/set_admin_permissions_v2

  • Destructive

    Suspend a member from a team

    Suspend a member from a team. Permission : Team member management Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

    POST /2/team/members/suspend

  • Destructive

    Deletes a team member's profile photo

    Deletes a team member's profile photo. Permission : Team member management.

    POST /2/team/members/delete_profile_photo

  • Destructive

    Deletes a team member's profile photo

    Deletes a team member's profile photo. Permission : Team member management.

    POST /2/team/members/delete_profile_photo_v2

  • Destructive

    Deletes a group

    Deletes a group. The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the :route:`groups/job_status/get` to determine whether this process has completed. Permission : Team member management.

    POST /2/team/groups/delete

  • Destructive

    Removes members from a group

    Removes members from a group. The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the :route:`groups/job_status/get` to determine whether this process has completed. This method permits removing the only owner of a group, even in cases where this is not possible via the web client. Permission : Team member management.

    POST /2/team/groups/members/remove

  • Destructive

    Sets a member's access type in a group

    Sets a member's access type in a group. Permission : Team member management.

    POST /2/team/groups/members/set_access_type

  • Destructive

    Revoke a linked application of the team member

    Revoke a linked application of the team member.

    POST /2/team/linked_apps/revoke_linked_app

  • Destructive

    Revoke a list of linked applications of the team members

    Revoke a list of linked applications of the team members.

    POST /2/team/linked_apps/revoke_linked_app_batch

  • Destructive

    Delete secondary emails from users Permission : Team member management

    Delete secondary emails from users Permission : Team member management. Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email.

    POST /2/team/members/secondary_emails/delete

Team Log

  • Read

    Retrieves team events

    Retrieves team events. If the result's :field:`GetTeamEventsResult.has_more` field is :val:`true`, call :route:`get_events/continue` with the returned cursor to retrieve more entries. If end_time is not specified in your request, you may use the returned cursor to poll :route:`get_events/continue` for new events. Many attributes note 'may be missing due to historical data gap'. Note that the file_operations category and & analogous paper events are not available on all Dropbox Business :link:`plans /business/plans-comparison`. Use :link:`features/get_values /developers/documentation/http/teams#team-features-get_values` to check for this feature. Permission : Team Auditing.

    POST /2/team_log/get_events

  • Read

    Once a cursor has been retrieved from :route:`get_events`, use this to paginate through all events

    Once a cursor has been retrieved from :route:`get_events`, use this to paginate through all events. Permission : Team Auditing.

    POST /2/team_log/get_events/continue

Users

  • Read

    Get information about a user's account

    Get information about a user's account.

    POST /2/users/get_account

  • Read

    Get information about multiple user accounts

    Get information about multiple user accounts. At most 300 accounts may be queried per request.

    POST /2/users/get_account_batch

  • Read

    Get information about the current user's account

    Get information about the current user's account.

    POST /2/users/get_current_account

  • Read

    Get a list of feature values that may be configured for the current account

    Get a list of feature values that may be configured for the current account.

    POST /2/users/features/get_values

  • Read

    Get the space usage information for the current user's account

    Get the space usage information for the current user's account.

    POST /2/users/get_space_usage

Get started

  1. Open Space settings → Connections and search for Dropbox.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.