> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Dropbox

> Integrate your application with the Dropbox API

## 🚀 Quickstart

Connect to Dropbox with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Dropbox*.
  </Step>

  <Step title="Authorize Dropbox">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Dropbox. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the Dropbox API">
    Let's make your first request to the Dropbox API. Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/2/files/list_folder" \
          -X POST \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>" \
          -H "Content-Type: application/json" \
          -d '{"path": ""}'
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.post({
            endpoint: '/2/files/list_folder',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>',
            body: { path: '' }
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Dropbox Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Dropbox OAuth app](/api-integrations/dropbox/how-to-register-your-own-dropbox-api-oauth-app)\
  Register an OAuth app with Dropbox and obtain credentials to connect it to Nango

Official docs: [Dropbox API documentation](https://developers.dropbox.com/oauth-guide)

## 🧩 Pre-built syncs & actions for Dropbox

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| Function name                         | Description                                                                      | Type                                           | Source code                                                                                                                                 |
| ------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `batch-copy-files-or-folders`         | Copy multiple files or folders to new Dropbox paths in one batch job             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/batch-copy-files-or-folders.ts)         |
| `batch-create-folders`                | Create multiple Dropbox folders in one batch request                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/batch-create-folders.ts)                |
| `batch-delete-files-or-folders`       | Delete multiple Dropbox files or folders in one batch job                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/batch-delete-files-or-folders.ts)       |
| `batch-move-files-or-folders`         | Move multiple Dropbox files or folders to new locations in one batch job.        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/batch-move-files-or-folders.ts)         |
| `check-batch-copy-files-or-folders`   | Check the status of a Dropbox batch copy job using its async job ID.             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/check-batch-copy-files-or-folders.ts)   |
| `check-batch-delete-files-or-folders` | Check the status of a Dropbox batch delete job using its async job ID.           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/check-batch-delete-files-or-folders.ts) |
| `check-batch-move-files-or-folders`   | Check the status of a Dropbox batch move job using its async job ID.             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/check-batch-move-files-or-folders.ts)   |
| `check-unshare-folder`                | Check the status of a Dropbox unshare folder job using its async job ID.         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/check-unshare-folder.ts)                |
| `copy-file-or-folder`                 | Copy a Dropbox file or folder to a different path.                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/copy-file-or-folder.ts)                 |
| `create-folder`                       | Create a folder at a Dropbox path.                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/create-folder.ts)                       |
| `create-shared-link`                  | Create a shared link for a Dropbox file or folder with optional settings.        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/create-shared-link.ts)                  |
| `create-user`                         | Creates a user in Dropbox. Requires Dropbox Business.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/create-user.ts)                         |
| `delete-file-or-folder`               | Delete a Dropbox file or folder by path                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/delete-file-or-folder.ts)               |
| `delete-user`                         | Deletes a user in Dropbox. Requires Dropbox Business.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/delete-user.ts)                         |
| `download-file`                       | Download file contents from Dropbox.                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/download-file.ts)                       |
| `download-folder-as-zip`              | Download a Dropbox folder as a zip archive                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/download-folder-as-zip.ts)              |
| `get-current-account`                 | Retrieve the authenticated Dropbox account profile.                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/get-current-account.ts)                 |
| `get-file-or-folder-metadata`         | Retrieve metadata for a Dropbox file or folder                                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/get-file-or-folder-metadata.ts)         |
| `get-file-temporary-link`             | Generate a temporary Dropbox link for file content streaming.                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/get-file-temporary-link.ts)             |
| `list-file-revisions`                 | List revisions for a Dropbox file by path or file id.                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/list-file-revisions.ts)                 |
| `list-folder`                         | List Dropbox folder contents with pagination and optional recursion.             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/list-folder.ts)                         |
| `list-shared-folders`                 | List shared folders available to the current Dropbox user.                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/list-shared-folders.ts)                 |
| `list-shared-links`                   | List shared links for the current user or for a specific path                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/list-shared-links.ts)                   |
| `modify-shared-link-settings`         | Update settings on an existing Dropbox shared link.                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/modify-shared-link-settings.ts)         |
| `move-file-or-folder`                 | Move a Dropbox file or folder to a different path                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/move-file-or-folder.ts)                 |
| `restore-file-revision`               | Restore a previous Dropbox file revision to the current path                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/restore-file-revision.ts)               |
| `revoke-shared-link`                  | Revoke a Dropbox shared link so it no longer grants access.                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/revoke-shared-link.ts)                  |
| `search-files-and-folders`            | Search Dropbox files and folders by query text and path scope.                   | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/search-files-and-folders.ts)            |
| `share-folder`                        | Turn a Dropbox folder into a shared folder for collaborators                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/share-folder.ts)                        |
| `unshare-folder`                      | Unshare a Dropbox shared folder as its owner.                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/unshare-folder.ts)                      |
| `upload-file`                         | Upload a small file directly to Dropbox.                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/upload-file.ts)                         |
| `upload-large-file`                   | Upload a large file to Dropbox with an upload session                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/actions/upload-large-file.ts)                   |
| `files`                               | Sync Dropbox file metadata from configured root paths using list folder cursors. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/syncs/files.ts)                                 |
| `folders`                             | Sync Dropbox folder metadata from configured root paths.                         | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/syncs/folders.ts)                               |
| `shared-folders`                      | Sync shared folder metadata visible to the current Dropbox user.                 | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/syncs/shared-folders.ts)                        |
| `shared-links`                        | Sync Dropbox shared links for the current user or configured path scopes.        | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/dropbox/syncs/shared-links.ts)                          |

***
