Dropbox

Files

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

Auth - Token - From Oauth1

Disables the access token used to authenticate the call.

Auth - Token - Revoke

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

File Properties - Properties - Add

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.

File Properties - Properties - Overwrite

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`.

File Properties - Properties - Remove

Search across property templates for particular property field values.

File Properties - Properties - Search

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

File Properties - Properties - Search - Continue

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.

File Properties - Properties - Update

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.

File Properties - Templates - Add For Team

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.

File Properties - Templates - Add For User

File Properties - Templates - Get For Team

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

File Properties - Templates - Get For User

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

File Properties - Templates - List For 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.

File Properties - Templates - List 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.

File Properties - Templates - Remove For Team

File Properties - Templates - Remove For User

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

File Properties - Templates - Update For Team

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.

File Properties - Templates - Update For User

File Requests - Create

File Requests - Get

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.

File Requests - List

File Requests - Update

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.

Files - Alpha - Get Metadata

Create a new file with the contents provided in the request. Note that this endpoint is part of the properties API alpha and is slightly different from :route:`upload`.
Do not use this to upload a file larger than 150 MB. Instead, create an upload session with :route:`upload_session/start`.

Files - Alpha - Upload

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.

Files - Copy

Copy multiple files or folders to different locations at once in the user's Dropbox.
If :field:`RelocationBatchArg.allow_shared_folder` is false, this route is atomic. If on entry failes, the whole transaction will abort. If :field:`RelocationBatchArg.allow_shared_folder` is true, not atomicity is guaranteed, but you will be able to copy the contents of shared folders to new locations.
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.

Files - Copy Batch

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

Files - Copy Batch - Check

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`.

Files - Copy Reference - Get

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

Files - Copy Reference - Save

Files - Copy V2

Files - Create Folder

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 :field:`CreateFolderBatchArg.force_async` flag.  Use :route:`create_folder_batch/check` to check the job status.

Files - 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.

Files - Create Folder Batch - Check

Files - Create Folder V2

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 :type:`FileMetadata` or :type:`FolderMetadata` for the item at time of deletion, and not a :type:`DeletedMetadata` object.

Files - Delete

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.

Files - Delete Batch

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

Files - Delete Batch - Check

Files - Delete V2

Files - Download

Download a folder from the user's Dropbox, as a zip file. The folder must be less than 1 GB in size and have fewer than 10,000 total files. The input cannot be a single file.

Files - Download Zip

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

Files - Get Metadata

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

Files - Get Preview

Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. Content-Type of the link is determined automatically by the file's mime type.

Files - Get Temporary Link

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

Files - Get Thumbnail

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 and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Files - Get Thumbnail Batch

Starts returning the contents of a folder. If the result's :field:`ListFolderResult.has_more` field is :val:`true`, call :route:`list_folder/continue` with the returned :field:`ListFolderResult.cursor` to retrieve more entries.
If you're using :field:`ListFolderArg.recursive` set to :val:`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 :type:`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 :type:`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 :field:`FolderSharingInfo.read_only` and set all its children's read-only statuses to match.
For each :type:`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: :type:`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.

Files - List Folder

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`.

Files - List Folder - Continue

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.

Files - List Folder - Get Latest Cursor

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. If you're looking for server-side notifications, check out our :link:`webhooks documentation https://www.dropbox.com/developers/reference/webhooks`.

Files - List Folder - Longpoll

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 :field:`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 :field:`ListRevisionsMode.id`. The :field:`ListRevisionsMode.id` mode is useful to retrieve revisions for a given file across moves or renames.

Files - List Revisions

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.

Files - Move

Move multiple files or folders to different locations at once in the user's Dropbox.
This route is 'all or nothing', which means if one entry fails, the whole transaction will abort.
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.

Files - Move Batch

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

Files - Move Batch - Check

Files - Move V2

Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).
Note: This endpoint is only available for Dropbox Business apps.

Files - Permanently Delete

Files - Properties - Add

Files - Properties - Overwrite

Files - Properties - Remove

Files - Properties - Template - Get

Files - Properties - Template - List

Files - Properties - Update

Files - Restore

Save a specified URL into a file in user's Dropbox. If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).

Files - Save Url

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

Files - Save Url - Check Job Status

Searches for files and folders.
Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing.

Files - Search

Create a new file with the contents provided in the request.
Do not use this to upload a file larger than 150 MB. Instead, create an upload session with :route:`upload_session/start`.

Files - Upload

Append more data to an upload session.
A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Files - Upload Session - Append

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 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Files - Upload Session - Append V2

Finish an upload session and save the uploaded data to the given file path.
A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Files - Upload Session - Finish

This route helps you commit many files at once into a user's Dropbox. Use :route:`upload_session/start` and :route:`upload_session/append_v2` 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_v2` call. The maximum size of a file one can upload to an upload session is 350 GB.
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.

Files - 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.

Files - Upload Session - Finish Batch - Check

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 MB.  This call starts a new upload session with the given data. You can then use :route:`upload_session/append_v2` to add more data and :route:`upload_session/finish` to save all the data to a file in Dropbox.
A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.
An upload session can be used for a maximum of 48 hours. Attempting to use an :field:`UploadSessionStartResult.session_id` with :route:`upload_session/append_v2` or :route:`upload_session/finish` more than 48 hours after its creation will return a :field:`UploadSessionLookupError.not_found`.

Files - Upload Session - Start

Marks the given Paper doc as archived.
Note: This action can be performed or undone by anyone with edit permissions to the doc.

Paper - Docs - Archive

Creates a new Paper doc with the provided content.

Paper - Docs - Create

Exports and downloads Paper doc either as HTML or markdown.

Paper - Docs - Download

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.

Paper - Docs - Folder Users - List

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

Paper - Docs - Folder Users - List - Continue

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.

Note: If the Paper doc is not in any folder (aka unfiled) the response will be empty.

Paper - Docs - Get Folder Info

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`.

Paper - Docs - List

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

Paper - Docs - List - Continue

Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered.

Note: This action can be performed only by the doc owner.

Paper - Docs - Permanently Delete

Gets the default sharing policy for the given Paper doc.

Paper - Docs - Sharing Policy - Get

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.

Note: 'public_sharing_policy' cannot be set to the value 'disabled' because this setting can be changed only via the team admin console.

Paper - Docs - Sharing Policy - Set

Updates an existing Paper doc with the provided content.

Paper - Docs - Update

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

Note: The Doc owner's permissions cannot be changed.

Paper - Docs - Users - Add

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.

Paper - Docs - Users - List

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

Paper - Docs - Users - List - Continue

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

Note: Doc owner cannot be removed.

Paper - Docs - Users - Remove

Sharing - Add File 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.
Apps must have full Dropbox access to use this endpoint.

Sharing - Add Folder Member

Identical to update_file_member but with less information returned.

Sharing - Change File Member Access

Returns the status of an asynchronous job.
Apps must have full Dropbox access to use this endpoint.

Sharing - Check Job Status

Returns the status of an asynchronous job for sharing a folder.
Apps must have full Dropbox access to use this endpoint.

Sharing - Check Remove Member Job Status

Sharing - Check Share Job Status

Create a shared link.
If a shared link already exists for the given path, that link is returned.
Note that in the returned :type:`PathLinkMetadata`, the :field:`PathLinkMetadata.url` field is the shortened URL if :field:`CreateSharedLinkArg.short_url` argument is set to :val:`true`.
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 :route:`revoke_shared_link`.

Sharing - Create Shared Link

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

Sharing - Create Shared Link With Settings

Sharing - Get File Metadata

Sharing - Get File Metadata - Batch

Returns shared folder metadata by its folder ID.
Apps must have full Dropbox access to use this endpoint.

Sharing - Get Folder Metadata

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

Dropbox integration connector

Managed authentication

Execute Dropbox operations on behalf of your customers

Auth - Token - From Oauth1

Auth - Token - Revoke

File Properties - Properties - Add

File Properties - Properties - Overwrite

File Properties - Properties - Remove

File Properties - Properties - Search

Work with Dropbox data collections

Trigger integrations on Dropbox events

Data Record Created

Data Record Updated

Data Record Deleted

Dropbox integration connector

Managed authentication

Execute Dropbox operations on behalf of your customersself.__wrap_n!=1&&self.__wrap_b(":Rast6:",1)

Auth - Token - From Oauth1

Auth - Token - Revoke

File Properties - Properties - Add

File Properties - Properties - Overwrite

File Properties - Properties - Remove

File Properties - Properties - Search

Work with Dropbox data collectionsself.__wrap_n!=1&&self.__wrap_b(":Rb4t6:",1)

Trigger integrations on Dropbox eventsself.__wrap_n!=1&&self.__wrap_b(":Rbct6:",1)

Data Record Created

Data Record Updated

Data Record Deleted

Execute Dropbox operations on behalf of your customers

Work with Dropbox data collections

Trigger integrations on Dropbox events