Files

Type

Dropbox

Download File

Get Connected Account Details

Files - Properties - Update

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

The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.
Apps must have full Dropbox access to use this endpoint.

Sharing - Relinquish File Membership

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

Sharing - List Folder Members

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

Sharing - Get Folder Metadata

Get information about the current user's account.

Users - Get Current Account

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

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

Sharing - Unshare File

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 :route:`list_shared_links` with the file as the :field:`ListSharedLinksArg.path` argument.

Sharing - Revoke Shared Link

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

Changes a member's access on a shared file.

Sharing - Update File Member

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

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:`create_folder_batch`. If success, it returns list of result for each entry.

Files - Create Folder Batch - Check

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

Sharing - Mount Folder

Files - Restore

File Requests - Update

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

Files - Properties - Template - Get

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

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

Search across property templates for particular property field values.

File Properties - Properties - Search

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

Files - Properties - Add

Sharing - Check Share Job Status

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

Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.
Apps must have full Dropbox access to use this endpoint.

Sharing - Remove Folder Member

Allows an owner or editor of a shared folder to update another member's permissions.
Apps must have full Dropbox access to use this endpoint.

Sharing - Update Folder Member

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

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

The current user unmounts the designated folder. They can re-mount the folder at a later time using :route:`mount_folder`.
Apps must have full Dropbox access to use this endpoint.

Sharing - Unmount Folder

Returns a list of all files shared with current user.
 Does not include files the user has received via shared folders, and does  not include unclaimed invitations.

Sharing - List Received Files

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

Files - Properties - Remove

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

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

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

Gets the default sharing policy for the given Paper doc.

Paper - Docs - Sharing Policy - Get

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

Sharing - Share Folder

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

Files - Save Url - Check Job Status

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

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

Files - Copy Reference - Save

Sharing - Add File Member

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

Sharing - List Folders - Continue

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

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

File Properties - Templates - Remove For User

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

Once a cursor has been retrieved from :route:`list_folder_members`, use this to paginate through all shared folder members.
Apps must have full Dropbox access to use this endpoint.

Sharing - List Folder Members - Continue

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

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

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

Files - Create Folder V2

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

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

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

File Properties - Properties - Search - Continue

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

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

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.
Note that the url field in the response is never the shortened URL.

Sharing - Get Shared Links

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

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

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

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

Users - Get Space Usage

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

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

List shared links of this user.
If no path is given, returns a list of all shared links for the current user.
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.

Sharing - List Shared Links

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

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

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

Sharing - List Received Files - Continue

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

Identical to update_file_member but with less information returned.

Sharing - Change File Member Access

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

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 :field:`LinkPermissions.resolved_visibility` of the returned :type:`SharedLinkMetadata` will reflect the actual visibility of the shared link and the :field:`LinkPermissions.requested_visibility` will reflect the requested visibility.

Sharing - Modify Shared Link Settings

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

Identical to remove_file_member_2 but with less information returned.

Sharing - Remove File Member

Disables the access token used to authenticate the call.

Auth - Token - Revoke

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

Sharing - Get Shared Link Metadata

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

Allows a shared folder owner to unshare the folder.
You'll need to call :route:`check_job_status` to determine if the action has completed successfully.
Apps must have full Dropbox access to use this endpoint.

Sharing - Unshare Folder

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

Sharing - List Mountable Folders - Continue

File Properties - Templates - Get For Team

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

Sharing - Relinquish Folder Membership

Files - Download

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

Sharing - Get File Metadata

Return the list of all shared folders the current user can mount or unmount.
Apps must have full Dropbox access to use this endpoint.

Sharing - List Mountable Folders

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

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

Files - Create Folder

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

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

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

Users - Get Account Batch

File Requests - Create

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

Sharing - List File Members

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

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.

Sharing - List File Members - Continue

Google Drive

Microsoft Sharepoint

MS OneDrive

# Continuous Import of Files and Folders (Drive Items) to Your App

This scenario enables your application to continuously sync and download Files and Folders (Drive Items) from any external application to your app's API. It handles the initial import of Drive Items and keeps them synchronized when a drive item is created, updated, or deleted in the external application.

When receiving Files data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

3. **Download File**:
   - Make a single API request to start file download from external app, it will return download file URI, that you can use to download file from any source in the same way

Continuously Import Files and Folders to my App

Import files and folders, download files and receive created/updated or deleted events

AWS S3

# Continuous Import of Folders to Your App

This scenario enables your application to continuously sync Folders from any external application to your app's API. It handles the initial import of Folders and keeps them synchronized when a Folder is created, updated, or deleted in the external application.

When receiving Folders data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Folders to my App

Import Folders and receive created/updated or deleted events

# Get all Folders

This scenario enables your application to get a complete list of Folders from any external application to your app's API in the same way. 

When receiving Folders data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

You will call a Integration.app REST API endpoint or SDK methods to retrieve a single page of Folders along with the `cursor` if next page is available.
Repeate this request in a loop from your code to retrieve all Folders page by page.


Get all Folders

Imports all Folders from any external application to your App.

# Realtime Full two-way Sync of Folders

This scenario enables your application to fully sync Folders between your app and any external application in both directions. It handles the initial import/export of Folders and then sends events when a Folder is created, updated, or deleted on any side, as close to real-time as possible.

Folder fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Folders in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Folders to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Folders

Bi-directional realtime sync of Folders with records deduplication

Dropbox API Integration Profile

Supercharge your product integrations today