> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useparagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Dropbox

## Required Scopes

To configure a Sync for Dropbox, you need to request the following scopes from your Dropbox OAuth application:

* `files.metadata.read`
* `files.content.read`
* `sharing.read`

Learn more about configuring scopes for your app in [Adding Integrations](/getting-started/adding-an-integration#create-a-developer-app).

## Synced Objects

Dropbox supports the following Synced Objects:

* [Files](/managed-sync/api/file-schema)
  <p>Dropbox Paper documents will be synced as HTML files.</p>
  <p>All other files will be available in their original format.</p>
* [Permissions](/managed-sync/permissions-api)

## Files

Send a request to [Enable Sync](/managed-sync/api/enable-a-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.

<Tabs>
  <Tab title="Global Sync">
    ```json Example theme={null}
    {
        "integration": "dropbox",
        "pipeline": "files",
        "configuration": {}
    }
    ```

    **Configuration options:**

    <ParamField path="orgWideSync" type="boolean">
      Set to `true` if using a Dropbox Team account. This will sync group permissions for folders and files.
    </ParamField>

    <ParamField path="mimeTypes" type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Folder Sync">
    ```json Example theme={null}
    {
        "integration": "dropbox",
        "pipeline": "files",
        "configuration": {
          "folderId": "/Documents"
        }
    }
    ```

    **Configuration options:**

    <ParamField path="folderId" type="string" required>
      A Dropbox folder path to limit the Sync scope to.
    </ParamField>

    <ParamField path="shallowSync" type="boolean">
      Set to `true` to sync only the direct children of the specified folder, without recursing into subfolders. Defaults to `false`.
    </ParamField>

    <ParamField path="orgWideSync" type="boolean">
      Set to `true` if using a Dropbox Team account. This will sync group permissions for this folder and its children.
    </ParamField>

    <ParamField path="mimeTypes" type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>

  <Tab title="Sync of specific files">
    ```json Example theme={null}
    {
        "integration": "dropbox",
        "pipeline": "files",
        "configuration": {
          "fileIds": ["id:4h9kzExampleXYZ987654321", "id:4h9kzExampleXYZ987654322"]
        }
    }
    ```

    **Configuration options:**

    <ParamField path="fileIds" type="string[]" required>
      A list of Dropbox file IDs to limit the Sync scope to.
    </ParamField>

    <ParamField path="orgWideSync" type="boolean">
      Set to `true` if using a Dropbox Team account. This will sync group permissions for this folder and its children.
    </ParamField>

    <ParamField path="mimeTypes" type="string[]">
      An optional array of MIME types to filter synced files. Only files matching the specified MIME types will be synced.
    </ParamField>
  </Tab>
</Tabs>