Dropbox

Required Scopes

To configure a Sync for Dropbox, you need to request the following scopes from your Dropbox OAuth application. Scopes tagged Permissions Sync are only needed if you use the Permissions API. Learn more about configuring scopes for your app in Adding Integrations.

Synced Objects

Dropbox supports the following Synced Objects:

Files
Dropbox Paper documents will be synced as HTML files.

All other files will be available in their original format.
Permissions

Files

Send a request to Enable Sync to start a file sync. Syncs for Dropbox can be created with one of the following configurations:

Global Sync: All files in the user’s Dropbox account will be synced.
Folder Sync: Only files in the specified folder will be synced (recursively including all subfolders by default).
Sync of specific files: Only a group of specific files will be synced.

Global Sync
Folder Sync
Sync of specific files

Example

{
    "integration": "dropbox",
    "pipeline": "files",
    "configuration": {}
}

Configuration options:

boolean

Set to true if using a Dropbox Team account. This will sync group permissions for folders and files.

string[]

An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.

string

An optional RE2 regular expression that filters synced files by filename. Only files whose name matches the pattern are synced. Folders are always traversed regardless of the pattern.Matching is unanchored and case-sensitive. Use the inline (?i) flag for case-insensitive matches, and anchors (^, $) for exact-name matches. Lookarounds and backreferences are not supported. Patterns are limited to 1000 characters.Example: (?i)\.pdf$ syncs only PDF files.

Example

{
    "integration": "dropbox",
    "pipeline": "files",
    "configuration": {
      "folderId": "/Documents"
    }
}

Configuration options:

string

required

The folder to limit the Sync scope to. Accepts a Dropbox path (e.g. /Documents), a folder ID (e.g. id:abc123), or a namespace ID (e.g. ns:14532919923).

For Dropbox Business accounts, paths are resolved relative to the team root namespace by default. Learn more about namespaces in the Dropbox Team Files guide.

boolean

Set to true to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to false.

boolean

Set to true if using a Dropbox Team account. This will sync group permissions for this folder and its children.

string[]

An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.

string

Example

{
    "integration": "dropbox",
    "pipeline": "files",
    "configuration": {
      "fileIds": ["id:4h9kzExampleXYZ987654321", "id:4h9kzExampleXYZ987654322"]
    }
}

Configuration options:

string[]

required

A list of Dropbox file IDs to limit the Sync scope to.

boolean

Set to true if using a Dropbox Team account. This will sync group permissions for this folder and its children.

string[]

An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.

string

Managed Sync

Sync API

Permissions API

Integrations Reference

Required Scopes

Synced Objects

Files