Dropbox Component

Manage files stored in Dropbox

Component key: dropbox

Description

Dropbox is a file sharing platform that allows teams to collaborate and share files with one another. The Dropbox component allows you to interact with the Dropbox API. You can upload, download, list, and move files within a Dropbox account.

API Documentation

This component was built using the Dropbox API Documentation

A common integration pattern involves listing files in a file store, and performing a series of actions on the array of files that are returned. See our looping over files quickstart for information about how to create a loop over an array of files.

Detecting changes in Dropbox

The List Changes action allows you to detect changes in your user's Dropbox folders. Create a flow that runs on a schedule and begin your flow with a List Changes action. That action will return a list of changes that have occurred since the flow was last run.

If you would like to detect and process changes to your customers' Dropbox accounts in real-time, see the Single-Endpoint Webhook Integrations guide on handling webhook requests from apps that require you to specify a single webhook endpoint.

Connections

OAuth 2.0

This component uses OAuth 2.0 to connect to Dropbox's API. To create a Dropbox OAuth 2.0 app, log in to Dropbox and open https://www.dropbox.com/developers/apps:

Select Create app.
Select that you want Scoped access.
Choose the type of access you want:
1. App folder access gives you access to a single folder in the user's Apps/ directory. A folder will be created with the same name as your OAuth app.
2. Full Dropbox access gives you access to all files and folders in a user's Dropbox account.
Give your app a name and click Create app.
1. Take note of the App key and App secret - you'll enter these in a Dropbox connection config variable.
Under the OAuth2 section add the Redirect URI as https://oauth2.prismatic.io/callback.

Under the Permissions tab, choose the permissions your app will need. The actions supported in this component relate to files, so you should grant the files.metadata.read and files.content.read permissions if you need read-only access, and also include the files.metadata.write and files.content.write permissions if you need to write files to a user's Dropbox account. You can safely ignore permissions listed under Collaboration and Account Info.

Input	Notes	Example
Authorize URL	The OAuth 2.0 Authorization URL for Dropbox	https://www.dropbox.com/oauth2/authorize?token_access_type=offline
App Key	Generate at https://www.dropbox.com/developers/apps
App Secret	Generate at https://www.dropbox.com/developers/apps
Scopes	Dropbox permission scopes are set within Dropbox on the OAuth application
Token URL	The OAuth 2.0 Token URL for Dropbox	https://api.dropboxapi.com/oauth2/token

Triggers

New and Updated Files

Checks for new and updated files on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
Connection
Include Deleted?	If true, the results will include entries for files and folders that used to exist but were deleted.	false
Recursive	If true, the response will contain contents of all subfolders.	false
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "instanceState": {
    "stepId": "someStepId"
  },
  "polledNoChanges": false,
  "payload": {
    "globalDebug": false,
    "headers": {
      "Content-Type": "application/json"
    },
    "queryParameters": null,
    "rawBody": {
      "data": null
    },
    "body": {
      "data": {
        "entries": [
          {
            ".tag": "deleted",
            "name": "example_deleted_file.png",
            "path_lower": "/testsubfolder/example_deleted_file.png",
            "path_display": "/TestSubfolder/example_deleted_file.png"
          },
          {
            ".tag": "file",
            "name": "example_added_file.png",
            "path_lower": "/testsubfolder/example_added_file.png",
            "path_display": "/TestSubfolder/example_added_file.png",
            "id": "id:someExampleId",
            "client_modified": "2024-11-20T18:29:39Z",
            "server_modified": "2024-11-21T18:07:17Z",
            "rev": "01627702307738900000002a67d8f21",
            "size": 331590,
            "is_downloadable": true,
            "content_hash": "exampleContentHashValue"
          }
        ],
        "cursor": "examplePaginationCursorValue",
        "has_more": false
      }
    },
    "pathFragment": "",
    "webhookUrls": {
      "Flow 1": "https://hooks.example.com/trigger/WEBHOOK_ID"
    },
    "webhookApiKeys": {
      "Flow 1": [
        "sample-api-key"
      ]
    },
    "invokeUrl": "https://hooks.example.com/trigger/WEBHOOK_ID",
    "executionId": "exampleExecutionId",
    "customer": {
      "id": "testCustomerId",
      "name": "Test Customer",
      "externalId": "testCustomerExternalId"
    },
    "instance": {
      "id": "testInstanceId",
      "name": "Test Instance"
    },
    "user": {
      "id": "testUserId",
      "email": "testUserEmail@example.com",
      "name": "Test User",
      "externalId": "testUserExternalId"
    },
    "integration": {
      "id": "testIntegrationId",
      "name": "Test Integration",
      "versionSequenceId": "testIntegrationVersionSequenceId",
      "externalVersion": "testExternalVersion"
    },
    "flow": {
      "id": "testFlowId",
      "name": "Test Flow Name"
    },
    "startedAt": "2024-11-21 18:07:22.778766+00"
  }
}

Webhook

Receive and validate webhook requests from Dropbox for webhooks you configure. | key: dropboxWebhook

Input	Notes	Example
Signing Secret	The 'App Secret' of your Dropbox app

Many other SaaS apps allow you to configure webhook URLs on a per-customer basis. They allow you to say "when data is updated for Acme Corp, notify Acme Corp's instance webhook URL".

Dropbox does not have customer-specific webhooks. Instead, they allow your OAuth application to designate a single webhook URL to be notified when updates occur. Whenever any of your users update data in Dropbox, your single webhook URL receives a request with an array of Dropbox account IDs that have changes.

The best way to handle these Dropbox requests is to create a "Router Integration" that routes Dropbox webhook requests to the correct customer instance(s).

When an instance of your Dropbox integration is created, it notifies the "Router Integration" of a new mapping between the authenticated user's Dropbox Account ID and the instance's flow's webhook URL.
When a webhook request comes from Dropbox with a list of Dropbox Account IDs with changes, the "Router Integration" loops over the account IDs, looks up the mapping of account ID to webhook URL, and makes a request to the webhook URL of the appropriate instance, causing it to run a flow that queries for changes.

An example "Router Integration" and a Dropbox integration that register itself with the router integration is available in GitHub. You can import and extend the integrations how you see fit.

Data Sources

List Folders

Fetch an array of folders | key: listFolders | type: picklist

Input	Notes	Example
Connection
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Entry Filter	Select a filter to return only files or folders. If both are selected, all will be returned.	all
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
Recursive	If true, the response will contain contents of all subfolders.	false
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User	either 'admin' or 'user'

{
  "result": [
    {
      "label": "/myexamplefolder - MyExampleFolder",
      "key": "0"
    },
    {
      "label": "/myexamplefolder/myimage.jpg - MyImage.jpg",
      "key": "1"
    }
  ]
}

List Shared Folders

Fetch an array of shared folders | key: listSharedFolders | type: picklist

Input	Notes	Example
Connection
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Folder Actions	A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder. This field is optional.	disable_viewer_info
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/

{
  "result": [
    {
      "label": "/myexamplefolder - MyExampleFolder",
      "key": "0"
    },
    {
      "label": "/myexamplefolder/myimage.jpg - MyImage.jpg",
      "key": "1"
    }
  ]
}

List Team Folders

Fetch an array of team's folders | key: listTeamFolders | type: picklist

Input	Notes	Example
Connection
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/

{
  "result": [
    {
      "label": "MyExampleFolder",
      "key": "0"
    }
  ]
}

Actions

Copy Object

Copy a Folder or File from one path to another | key: copyObject

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
From Path	The location of a source file within a Dropbox share. Include a leading /.	/path/to/source/file.txt
To Path	The location of a destination file within a Dropbox share. Include a leading /.	/path/to/destination/file.txt

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "metadata": {
        ".tag": "file",
        "name": "myCopy",
        "id": "exampleId",
        "client_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
        "server_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
        "size": 2048
      }
    }
  }
}

Create Folder

Create a Folder at the specified path | key: createFolder

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Path	The location of a file within a Dropbox share. Include a leading /.	/path/to/file.txt

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "metadata": {
        "id": "exampleId",
        "name": "myFolderName"
      }
    }
  }
}

Create Shared Link

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

Input	Notes	Example
Access	Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.
Allow Download	Boolean flag to allow or not download capabilities for shared links.	false
Audience
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Expires	Expiration time of the shared link. By default the link won't expire.	2021-01-01T00:00:00Z
Link Password	If the shared link has a password, this parameter can be used.	anExamplePassword
Path	The location of a file within a Dropbox share. Include a leading /.	/path/to/file.txt
Require Password	Boolean flag to enable or disable password protection.	false
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "file",
      "client_modified": "2015-05-12T15:50:38Z",
      "id": "id:a4ayc_80_OEAAAAAAAAAXw",
      "link_permissions": {
        "allow_comments": true,
        "allow_download": true,
        "audience_options": [
          {
            "allowed": true,
            "audience": {
              ".tag": "public"
            }
          },
          {
            "allowed": false,
            "audience": {
              ".tag": "team"
            }
          },
          {
            "allowed": true,
            "audience": {
              ".tag": "no_one"
            }
          }
        ],
        "can_allow_download": true,
        "can_disallow_download": false,
        "can_remove_expiry": false,
        "can_remove_password": true,
        "can_revoke": false,
        "can_set_expiry": false,
        "can_set_password": true,
        "can_use_extended_sharing_controls": false,
        "require_password": false,
        "resolved_visibility": {
          ".tag": "public"
        },
        "revoke_failure_reason": {
          ".tag": "owner_only"
        },
        "team_restricts_comments": true,
        "visibility_policies": [
          {
            "allowed": true,
            "policy": {
              ".tag": "public"
            },
            "resolved_policy": {
              ".tag": "public"
            }
          },
          {
            "allowed": true,
            "policy": {
              ".tag": "password"
            },
            "resolved_policy": {
              ".tag": "password"
            }
          }
        ]
      },
      "name": "Prime_Numbers.txt",
      "path_lower": "/homework/math/prime_numbers.txt",
      "rev": "a1c10ce0dd78",
      "server_modified": "2015-05-12T15:50:38Z",
      "size": 7212,
      "team_member_info": {
        "display_name": "Roger Rabbit",
        "member_id": "dbmid:abcd1234",
        "team_info": {
          "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
          "name": "Acme, Inc."
        }
      },
      "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0"
    }
  }
}

Delete Object

Delete a Folder or File at the specified path | key: deleteObject

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Path	The location of a file within a Dropbox share. Include a leading /.	/path/to/file.txt

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "metadata": {
        ".tag": "file",
        "name": "myCopy",
        "id": "exampleId",
        "client_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
        "server_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
        "size": 2048
      }
    }
  }
}

Download File

Download the file (< 150MB) at the specified path | key: downloadFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Download as Zip	Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size.	false
Connection
Path	The location of a file within a Dropbox share. Include a leading /.	/path/to/file.txt

{
  "data": {
    "type": "Buffer",
    "data": [
      101,
      120,
      97,
      109,
      112,
      108,
      101
    ]
  },
  "contentType": "application/octet"
}

Export File

Export the file at the specified path | key: exportFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Directory Path	The path of the file to be exported.	/Homework/math/Prime_Numbers.gsheet
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "export_metadata": {
        "export_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "name": "Prime_Numbers.xlsx",
        "size": 7189
      },
      "file_metadata": {
        "client_modified": "2015-05-12T15:50:38Z",
        "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
        "file_lock_info": {
          "created": "2015-05-12T15:50:38Z",
          "is_lockholder": true,
          "lockholder_name": "Imaginary User"
        },
        "has_explicit_shared_members": false,
        "id": "id:a4ayc_80_OEAAAAAAAAAXw",
        "is_downloadable": true,
        "name": "Prime_Numbers.txt",
        "path_display": "/Homework/math/Prime_Numbers.txt",
        "path_lower": "/homework/math/prime_numbers.txt",
        "property_groups": [
          {
            "fields": [
              {
                "name": "Security Policy",
                "value": "Confidential"
              }
            ],
            "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
          }
        ],
        "rev": "a1c10ce0dd78",
        "server_modified": "2015-05-12T15:50:38Z",
        "sharing_info": {
          "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
          "parent_shared_folder_id": "84528192421",
          "read_only": true
        },
        "size": 7212
      }
    }
  }
}

Get Current Account

Get information about the currently authenticated user | key: getCurrentAccount

Input	Notes	Example
Connection

{
  "data": {
    "account_id": "dbid:EXAMPLE",
    "name": {
      "given_name": "John",
      "surname": "Doe",
      "familiar_name": "John",
      "display_name": "John Doe",
      "abbreviated_name": "JD"
    },
    "email": "john.doe@example.com",
    "email_verified": true,
    "profile_photo_url": "",
    "disabled": false,
    "country": "US",
    "locale": "en",
    "referral_link": "",
    "is_paired": true,
    "account_type": {
      ".tag": "basic"
    },
    "root_info": {
      ".tag": "user",
      "root_namespace_id": "123456789",
      "home_namespace_id": "123456789"
    }
  }
}

Get Download Status

Get the status of a file download from a URL to Dropbox | key: getDownloadStatus

Input	Notes	Example
Async Job ID	The ID of the asynchronous job. From the response of the Save From URL action would be a good place to get this value.	nMvNReawvD4AAAAAAAAAAQ
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "in_progress"
    }
  }
}

Get File Lock

Return the lock metadata for the given list of paths | key: getFileLock

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Dynamic Paths	An optional list of paths (Use this, File Paths or both)	["/path/to/file", "/path/to/another/file"]
File Path	This represents the source files's path. Include a leading / (Use this, Dynamic Paths or both)	/path/to/source/file.txt
Team Member ID	Used to specify the user to act on behalf of.	dbmid:abcd1234

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "entries": [
        {
          ".tag": "success",
          "lock": {
            "content": {
              ".tag": "single_user",
              "created": "2015-05-12T15:50:38Z",
              "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "lock_holder_team_id": "dbtid:1234abcd"
            }
          },
          "metadata": {
            ".tag": "file",
            "client_modified": "2015-05-12T15:50:38Z",
            "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "file_lock_info": {
              "created": "2015-05-12T15:50:38Z",
              "is_lockholder": true,
              "lockholder_name": "Imaginary User"
            },
            "has_explicit_shared_members": false,
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "is_downloadable": true,
            "name": "Prime_Numbers.txt",
            "path_display": "/Homework/math/Prime_Numbers.txt",
            "path_lower": "/homework/math/prime_numbers.txt",
            "property_groups": [
              {
                "fields": [
                  {
                    "name": "Security Policy",
                    "value": "Confidential"
                  }
                ],
                "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
              }
            ],
            "rev": "a1c10ce0dd78",
            "server_modified": "2015-05-12T15:50:38Z",
            "sharing_info": {
              "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "parent_shared_folder_id": "84528192421",
              "read_only": true
            },
            "size": 7212
          }
        }
      ]
    }
  }
}

Get Metadata for File or Folder

Returns the metadata for a file or folder. | key: getMetadata

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Include Deleted	DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.	false
Include Has Explicit Shared Members	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.	false
Include Media Info	If true, FileMetadata.media_info is set for photo and video.	false
Path	The path of a file or folder on Dropbox to get metadata for	id:a4ayc_80_OEAAAAAAAAAYa \|\| /Homework/math
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "file",
      "client_modified": "2015-05-12T15:50:38Z",
      "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "file_lock_info": {
        "created": "2015-05-12T15:50:38Z",
        "is_lockholder": true,
        "lockholder_name": "Imaginary User"
      },
      "has_explicit_shared_members": false,
      "id": "id:a4ayc_80_OEAAAAAAAAAXw",
      "is_downloadable": true,
      "name": "Prime_Numbers.txt",
      "path_display": "/Homework/math/Prime_Numbers.txt",
      "path_lower": "/homework/math/prime_numbers.txt",
      "property_groups": [
        {
          "fields": [
            {
              "name": "Security Policy",
              "value": "Confidential"
            }
          ],
          "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
        }
      ],
      "rev": "a1c10ce0dd78",
      "server_modified": "2015-05-12T15:50:38Z",
      "sharing_info": {
        "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "parent_shared_folder_id": "84528192421",
        "read_only": true
      },
      "size": 7212
    }
  }
}

Get Shared Link File

Download the shared link's file from a user's Dropbox. | key: getSharedLinkFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Link Password	If the shared link has a password, this parameter can be used.	anExamplePassword
Directory Path	If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.	/Homework/math/Prime_Numbers.gsheet
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Shared Link URL	StringURL of the shared link.	https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "file",
      "client_modified": "2015-05-12T15:50:38Z",
      "id": "id:a4ayc_80_OEAAAAAAAAAXw",
      "link_permissions": {
        "allow_comments": true,
        "allow_download": true,
        "audience_options": [
          {
            "allowed": true,
            "audience": {
              ".tag": "public"
            }
          },
          {
            "allowed": false,
            "audience": {
              ".tag": "team"
            }
          },
          {
            "allowed": true,
            "audience": {
              ".tag": "no_one"
            }
          }
        ],
        "can_allow_download": true,
        "can_disallow_download": false,
        "can_remove_expiry": false,
        "can_remove_password": true,
        "can_revoke": false,
        "can_set_expiry": false,
        "can_set_password": true,
        "can_use_extended_sharing_controls": false,
        "require_password": false,
        "resolved_visibility": {
          ".tag": "public"
        },
        "revoke_failure_reason": {
          ".tag": "owner_only"
        },
        "team_restricts_comments": true,
        "visibility_policies": [
          {
            "allowed": true,
            "policy": {
              ".tag": "public"
            },
            "resolved_policy": {
              ".tag": "public"
            }
          },
          {
            "allowed": true,
            "policy": {
              ".tag": "password"
            },
            "resolved_policy": {
              ".tag": "password"
            }
          }
        ]
      },
      "name": "Prime_Numbers.txt",
      "path_lower": "/homework/math/prime_numbers.txt",
      "rev": "a1c10ce0dd78",
      "server_modified": "2015-05-12T15:50:38Z",
      "size": 7212,
      "team_member_info": {
        "display_name": "Roger Rabbit",
        "member_id": "dbmid:abcd1234",
        "team_info": {
          "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
          "name": "Acme, Inc."
        }
      },
      "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0"
    }
  }
}

Get Shared Metadata for File

Returns shared file metadata. | key: getSharedMetadataForFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
File Id	The ID for the shared file.	id:3kmLmQFnf1AAAAAAAAAAAw
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "access_type": {
        ".tag": "viewer"
      },
      "id": "id:3kmLmQFnf1AAAAAAAAAAAw",
      "name": "file.txt",
      "owner_display_names": [
        "Jane Doe"
      ],
      "owner_team": {
        "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
        "name": "Acme, Inc."
      },
      "path_display": "/dir/file.txt",
      "path_lower": "/dir/file.txt",
      "permissions": [],
      "policy": {
        "acl_update_policy": {
          ".tag": "owner"
        },
        "member_policy": {
          ".tag": "anyone"
        },
        "resolved_member_policy": {
          ".tag": "team"
        },
        "shared_link_policy": {
          ".tag": "anyone"
        }
      },
      "preview_url": "https://www.dropbox.com/scl/fi/fir9vjelf",
      "time_invited": "2016-01-20T00:00:00Z"
    }
  }
}

Get Shared Metadata for Folder

Returns shared folder metadata. | key: getSharedMetadataForFolder

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Shared Folder ID	The ID of the shared folder to retrieve metadata for	84528192421
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "access_inheritance": {
        ".tag": "inherit"
      },
      "access_type": {
        ".tag": "owner"
      },
      "is_inside_team_folder": false,
      "is_team_folder": false,
      "link_metadata": {
        "audience_options": [
          {
            ".tag": "public"
          },
          {
            ".tag": "team"
          },
          {
            ".tag": "members"
          }
        ],
        "current_audience": {
          ".tag": "public"
        },
        "link_permissions": [
          {
            "action": {
              ".tag": "change_audience"
            },
            "allow": true
          }
        ],
        "password_protected": false,
        "url": ""
      },
      "name": "dir",
      "path_lower": "/dir",
      "permissions": [],
      "policy": {
        "acl_update_policy": {
          ".tag": "owner"
        },
        "member_policy": {
          ".tag": "anyone"
        },
        "resolved_member_policy": {
          ".tag": "team"
        },
        "shared_link_policy": {
          ".tag": "anyone"
        }
      },
      "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf",
      "shared_folder_id": "84528192421",
      "time_invited": "2016-01-20T00:00:00Z"
    }
  }
}

Get Team Members

Get Team Members by Member ID, External ID, or Email | key: getTeamMembers

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Lookup By
Value

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "members_info": [
        {
          ".tag": "member_info",
          "profile": {
            "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
            "email": "tami@seagull.com",
            "email_verified": false,
            "external_id": "244423",
            "groups": [
              "g:e2db7665347abcd600000000001a2b3c"
            ],
            "joined_on": "2015-05-12T15:50:38Z",
            "member_folder_id": "20",
            "membership_type": {
              ".tag": "full"
            },
            "name": {
              "abbreviated_name": "FF",
              "display_name": "Franz Ferdinand (Personal)",
              "familiar_name": "Franz",
              "given_name": "Franz",
              "surname": "Ferdinand"
            },
            "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128",
            "secondary_emails": [
              {
                "email": "grape@strawberry.com",
                "is_verified": false
              },
              {
                "email": "apple@orange.com",
                "is_verified": true
              }
            ],
            "status": {
              ".tag": "active"
            },
            "team_member_id": "dbmid:FDFSVF-DFSDF"
          },
          "roles": [
            {
              "description": "Add, remove, and manage member accounts.",
              "name": "User management admin",
              "role_id": "pid_dbtmr:3456"
            }
          ]
        }
      ]
    }
  }
}

Get Temporary Link

Get a temporary link to stream content of a file. | key: getTemporaryLink

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Path	The path to the file you want a temporary link to	/video.mp4
Team Member ID	Used to specify the user to act on behalf of.	dbmid:abcd1234

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "metadata": {
        "name": "drums.jpg",
        "path_lower": "/drums.jpg",
        "path_display": "/drums.jpg",
        "id": "id:kXzCDysyTmQAAAAAAAAAGw",
        "client_modified": "2023-12-12T00:25:58Z",
        "server_modified": "2023-12-12T00:25:59Z",
        "rev": "60c45183ecb69f3e2a861",
        "size": 175342,
        "is_downloadable": true,
        "content_hash": "2960e5e1f4e54e849d63862010035aea6d4f691aacc76abe5f33a80d670ec113"
      },
      "link": "https://uc925b3fcc7a2208235a92b0e7e8.dl.dropboxusercontent.com/cd/0/get/COQEC7ffJgExogeJr8ngG5GH_4jW-iN6PC1heBZVwhZPs-3Wis_TJVR5GDHQnrLSuZRn8EhZVxFFxU9vOcpwZ2tbpIC59w1dQkaZ9Vs0q-8YPfD0hfLTOWy7iMpx5ymz6J9k6nnzHyr08sICt-RcM5jMk2ET8lwSQoQCeW6_TG6lWA/file"
    }
  }
}

Get Temporary Upload Link

Get a temporary presigned link to upload a file | key: getTemporaryUploadLink

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Duration	How long the link will be valid, in seconds. Defaults to 1 hour.	3600
Path	The location of a file within a Dropbox share. Include a leading /.	/path/to/file.txt

The Get Temporary Upload Link action allows you to fetch a presigned URL from Dropbox that can be used to upload a file directly to Dropbox. This is handy if you have a large file that you want to upload to Dropbox, but cannot upload the file through a flow.

After fetching a presigned URL, your app can upload a file directly to Dropbox. Note that your request must be a POST request and your content-type header must be application/octet-stream.

For example,

curl --request POST \
  --upload-file ./my-file.png \
  --header "content-type: application/octet-stream" \
  https://content.dropboxapi.com/apitul/1/ExAmPlE

Dropbox documentation notes that the maximum size for a file uploaded via a presigned URL is 150MB.

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "link": "https://content.dropboxapi.com/..."
    }
  }
}

List Changes

List changes that have been made to files in this folder since the last time this action was run. | key: listChanges

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
Connection
Include Deleted?	If true, the results will include entries for files and folders that used to exist but were deleted.	false
Recursive	If true, the response will contain contents of all subfolders.	false
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

The first time this action runs, it takes note of the current cursor returned by Dropbox, and returns no changes. Subsequent runs of this step use that cursor to determine what has changed since the last time this step ran.

{
  "data": {
    "entries": [
      {
        ".tag": "deleted",
        "name": "my-old-image.png",
        "path_lower": "/my-old-image.png",
        "path_display": "/my-old-image.png"
      },
      {
        ".tag": "file",
        "name": "my-new-image.png",
        "path_lower": "/my-new-image.png",
        "path_display": "/my-new-image.png",
        "id": "id:BTY6k_2K8PAAAAAAAAAX9g",
        "client_modified": "2022-12-12T21:39:30Z",
        "server_modified": "2022-12-12T22:40:57Z",
        "rev": "5efa9326918a601c39731",
        "size": 1758021,
        "is_downloadable": true,
        "content_hash": "dc05a61ecd59d294da1e971c4e40a980b9042c633b7bc777367991a046d2b32d"
      }
    ],
    "cursor": "AAFCBKRdVxEXAMPLE",
    "has_more": false
  },
  "instanceState": {}
}

List Folder

List Folder contents at the specified path | key: listFolder

Input	Notes	Example
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
Recursive	If true, the response will contain contents of all subfolders.	false
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "entries": [
        {
          ".tag": "folder",
          "id": "exampleId",
          "name": "MyExampleFolder",
          "path_lower": "/myexamplefolder"
        },
        {
          ".tag": "file",
          "id": "exampleId",
          "name": "MyImage.jpg",
          "path_lower": "/myexamplefolder/myimage.jpg",
          "client_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
          "server_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
          "rev": "681a01c39731",
          "size": 213654
        }
      ],
      "cursor": "hgL45HTslKOhj1_GEut-DVuaNs4xrXzpwQZRyJ0-KCW0wWMQ5DZu68__ULJa0zDcBp3ZrMlCj3-ZuOy4kjc9H2o7Ohk9UsId0sxVZrXFX",
      "has_more": true
    }
  }
}

List Shared Folders

List Shared Folders contents | key: listSharingFolder

Input	Notes	Example
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Folder Actions	A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder. This field is optional.	disable_viewer_info
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
      "entries": [
        {
          "access_inheritance": {
            ".tag": "inherit"
          },
          "access_type": {
            ".tag": "owner"
          },
          "is_inside_team_folder": false,
          "is_team_folder": false,
          "link_metadata": {
            "audience_options": [
              {
                ".tag": "public"
              },
              {
                ".tag": "team"
              },
              {
                ".tag": "members"
              }
            ],
            "current_audience": {
              ".tag": "public"
            },
            "link_permissions": [
              {
                "action": {
                  ".tag": "change_audience"
                },
                "allow": true
              }
            ],
            "password_protected": false,
            "url": ""
          },
          "name": "dir",
          "path_lower": "/dir",
          "permissions": [],
          "policy": {
            "acl_update_policy": {
              ".tag": "owner"
            },
            "member_policy": {
              ".tag": "anyone"
            },
            "resolved_member_policy": {
              ".tag": "team"
            },
            "shared_link_policy": {
              ".tag": "anyone"
            }
          },
          "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf",
          "shared_folder_id": "84528192421",
          "time_invited": "2016-01-20T00:00:00Z"
        }
      ]
    }
  }
}

List Shared Links

List Folder contents at the specified path | key: listSharedLinks

Input	Notes	Example
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Direct Only	Links to parent folders can be suppressed by setting direct_only to true.	false
Connection
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
      "has_more": true,
      "links": [
        {
          ".tag": "file",
          "client_modified": "2015-05-12T15:50:38Z",
          "id": "id:a4ayc_80_OEAAAAAAAAAXw",
          "link_permissions": {
            "allow_comments": true,
            "allow_download": true,
            "audience_options": [
              {
                "allowed": true,
                "audience": {
                  ".tag": "public"
                }
              },
              {
                "allowed": false,
                "audience": {
                  ".tag": "team"
                }
              },
              {
                "allowed": true,
                "audience": {
                  ".tag": "no_one"
                }
              }
            ],
            "can_allow_download": true,
            "can_disallow_download": false,
            "can_remove_expiry": false,
            "can_remove_password": true,
            "can_revoke": false,
            "can_set_expiry": false,
            "can_set_password": true,
            "can_use_extended_sharing_controls": false,
            "require_password": false,
            "resolved_visibility": {
              ".tag": "public"
            },
            "revoke_failure_reason": {
              ".tag": "owner_only"
            },
            "team_restricts_comments": true,
            "visibility_policies": [
              {
                "allowed": true,
                "policy": {
                  ".tag": "public"
                },
                "resolved_policy": {
                  ".tag": "public"
                }
              },
              {
                "allowed": true,
                "policy": {
                  ".tag": "password"
                },
                "resolved_policy": {
                  ".tag": "password"
                }
              }
            ]
          },
          "name": "Prime_Numbers.txt",
          "path_lower": "/homework/math/prime_numbers.txt",
          "rev": "a1c10ce0dd78",
          "server_modified": "2015-05-12T15:50:38Z",
          "size": 7212,
          "team_member_info": {
            "display_name": "Roger Rabbit",
            "member_id": "dbmid:abcd1234",
            "team_info": {
              "id": "dbtid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
              "name": "Acme, Inc."
            }
          },
          "url": "https://www.dropbox.com/s/2sn712vy1ovegw8/Prime_Numbers.txt?dl=0"
        }
      ]
    }
  }
}

List Team's Folders

List Team's Folder contents | key: listTeamFolder

Input	Notes	Example
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
      "has_more": false,
      "team_folders": [
        {
          "content_sync_settings": [
            {
              "id": "id:a4ayc_80_OEAAAAAAAAAXw",
              "sync_setting": {
                ".tag": "default"
              }
            }
          ],
          "is_team_shared_dropbox": false,
          "name": "Marketing",
          "status": {
            ".tag": "active"
          },
          "sync_setting": {
            ".tag": "default"
          },
          "team_folder_id": "123456789"
        }
      ]
    }
  }
}

Lock File

Lock the files at the given paths | key: lockFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Dynamic Paths	An optional list of paths (Use this, File Paths or both)	["/path/to/file", "/path/to/another/file"]
File Path	This represents the source files's path. Include a leading / (Use this, Dynamic Paths or both)	/path/to/source/file.txt
Team Member ID	Used to specify the user to act on behalf of.	dbmid:abcd1234

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "entries": [
        {
          ".tag": "success",
          "lock": {
            "content": {
              ".tag": "single_user",
              "created": "2015-05-12T15:50:38Z",
              "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "lock_holder_team_id": "dbtid:1234abcd"
            }
          },
          "metadata": {
            ".tag": "file",
            "client_modified": "2015-05-12T15:50:38Z",
            "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "file_lock_info": {
              "created": "2015-05-12T15:50:38Z",
              "is_lockholder": true,
              "lockholder_name": "Imaginary User"
            },
            "has_explicit_shared_members": false,
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "is_downloadable": true,
            "name": "Prime_Numbers.txt",
            "path_display": "/Homework/math/Prime_Numbers.txt",
            "path_lower": "/homework/math/prime_numbers.txt",
            "property_groups": [
              {
                "fields": [
                  {
                    "name": "Security Policy",
                    "value": "Confidential"
                  }
                ],
                "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
              }
            ],
            "rev": "a1c10ce0dd78",
            "server_modified": "2015-05-12T15:50:38Z",
            "sharing_info": {
              "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "parent_shared_folder_id": "84528192421",
              "read_only": true
            },
            "size": 7212
          }
        }
      ]
    }
  }
}

Move Object

Move a Folder or File from one path to another | key: moveObject

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
From Path	The location of a source file within a Dropbox share. Include a leading /.	/path/to/source/file.txt
To Path	The location of a destination file within a Dropbox share. Include a leading /.	/path/to/destination/file.txt

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "metadata": {
        ".tag": "file",
        "name": "myCopy",
        "id": "exampleId",
        "client_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
        "server_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
        "size": 2048
      }
    }
  }
}

Raw Request

Send raw HTTP request to Dropbox | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/file_requests/create), The base URL is already included (https://api.dropboxapi.com/2). For example, to connect to https://api.dropboxapi.com/2/file_requests/create, only /file_requests/create is entered in this field.	/file_requests/create
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
Team User Type	The type of user to connect with. Admin or User

Save From URL

Save a file from a URL to Dropbox | key: saveFromUrl

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
To Path	The path with file name with extension where the URL will be saved to in Dropbox.	/path/to/file.txt
URL to Save	The URL to save to Dropbox	https://example.com/file.txt
Wait Until Complete	Whether to wait for the operation to complete.	false

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "async_job_id",
      "async_job_id": "LnMobEc7XVEAAAAAAAAAAQ"
    }
  }
}

Search Files

Search for files at the specified path | key: searchFiles

Input	Notes	Example
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
File Name	The name of a file within a Dropbox share.	fileName.txt
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "has_more": false,
      "matches": [
        {
          "metadata": {
            ".tag": "metadata",
            "metadata": {
              ".tag": "file",
              "client_modified": "2015-05-12T15:50:38Z",
              "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
              "has_explicit_shared_members": false,
              "id": "id:a4ayc_80_OEAAAAAAAAAXw",
              "is_downloadable": true,
              "name": "Prime_Numbers.txt",
              "path_display": "/Homework/math/Prime_Numbers.txt",
              "path_lower": "/homework/math/prime_numbers.txt",
              "rev": "a1c10ce0dd78",
              "server_modified": "2015-05-12T15:50:38Z",
              "sharing_info": {
                "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "parent_shared_folder_id": "84528192421",
                "read_only": true
              },
              "size": 7212
            }
          }
        }
      ]
    }
  }
}

Search Folders

Search for folders at the specified path | key: searchFolders

Input	Notes	Example
Cursor	Specify the cursor returned by your last call to list_folder or list_folder/continue.	lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.	25
Directory Path	The path to a directory within a Dropbox share. Include a leading /.	/path/to/my/directory/
Folder Name	The name of the folder to search for	My Folder
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "has_more": false,
      "matches": [
        {
          "metadata": {
            ".tag": "metadata",
            "metadata": {
              ".tag": "file",
              "client_modified": "2015-05-12T15:50:38Z",
              "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
              "has_explicit_shared_members": false,
              "id": "id:a4ayc_80_OEAAAAAAAAAXw",
              "is_downloadable": true,
              "name": "Prime_Numbers.txt",
              "path_display": "/Homework/math/Prime_Numbers.txt",
              "path_lower": "/homework/math/prime_numbers.txt",
              "rev": "a1c10ce0dd78",
              "server_modified": "2015-05-12T15:50:38Z",
              "sharing_info": {
                "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "parent_shared_folder_id": "84528192421",
                "read_only": true
              },
              "size": 7212
            }
          }
        }
      ]
    }
  }
}

Share a folder with collaborators. Most sharing will be completed synchronously. Large folders will be completed asynchronously. | key: shareFolder

Input	Notes	Example
Access Inheritance	The access inheritance settings for the folder.
ACL Update Policy	Who can add and remove members of this shared folder.
Actions	A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder.
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Force Async	Whether to force the share to happen asynchronously.	false
Member Policy	Who can be a member of this shared folder. Only applicable if the current user is on a team.
Directory Path	The path or the file id to the folder to share. If it does not exist, then a new one is created.	/example/workspace
Shared Link Policy	The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.members.
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User
Viewer Info Policy	Who can enable/disable viewer info for this shared folder.

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "complete",
      "access_inheritance": {
        ".tag": "inherit"
      },
      "access_type": {
        ".tag": "owner"
      },
      "is_inside_team_folder": false,
      "is_team_folder": false,
      "link_metadata": {
        "audience_options": [
          {
            ".tag": "public"
          },
          {
            ".tag": "team"
          },
          {
            ".tag": "members"
          }
        ],
        "current_audience": {
          ".tag": "public"
        },
        "link_permissions": [
          {
            "action": {
              ".tag": "change_audience"
            },
            "allow": true
          }
        ],
        "password_protected": false,
        "url": ""
      },
      "name": "dir",
      "path_lower": "/dir",
      "permissions": [],
      "policy": {
        "acl_update_policy": {
          ".tag": "owner"
        },
        "member_policy": {
          ".tag": "anyone"
        },
        "resolved_member_policy": {
          ".tag": "team"
        },
        "shared_link_policy": {
          ".tag": "anyone"
        }
      },
      "preview_url": "https://www.dropbox.com/scl/fo/fir9vjelf",
      "shared_folder_id": "84528192421",
      "time_invited": "2016-01-20T00:00:00Z"
    }
  }
}

Unlock File

Unlock the files at the given paths | key: unlockFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Dynamic Paths	An optional list of paths (Use this, File Paths or both)	["/path/to/file", "/path/to/another/file"]
File Path	This represents the source files's path. Include a leading / (Use this, Dynamic Paths or both)	/path/to/source/file.txt
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "entries": [
        {
          ".tag": "success",
          "lock": {
            "content": {
              ".tag": "single_user",
              "created": "2015-05-12T15:50:38Z",
              "lock_holder_account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "lock_holder_team_id": "dbtid:1234abcd"
            }
          },
          "metadata": {
            ".tag": "file",
            "client_modified": "2015-05-12T15:50:38Z",
            "content_hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            "file_lock_info": {
              "created": "2015-05-12T15:50:38Z",
              "is_lockholder": true,
              "lockholder_name": "Imaginary User"
            },
            "has_explicit_shared_members": false,
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "is_downloadable": true,
            "name": "Prime_Numbers.txt",
            "path_display": "/Homework/math/Prime_Numbers.txt",
            "path_lower": "/homework/math/prime_numbers.txt",
            "property_groups": [
              {
                "fields": [
                  {
                    "name": "Security Policy",
                    "value": "Confidential"
                  }
                ],
                "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
              }
            ],
            "rev": "a1c10ce0dd78",
            "server_modified": "2015-05-12T15:50:38Z",
            "sharing_info": {
              "modified_by": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
              "parent_shared_folder_id": "84528192421",
              "read_only": true
            },
            "size": 7212
          }
        }
      ]
    }
  }
}

Unshare File

Remove all members from this file. Does not remove inherited members. | key: unshareFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
File Id	The ID for the shared file.	id:3kmLmQFnf1AAAAAAAAAAAw
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": null
  }
}

Unshare Folder

Allows a shared folder owner to unshare the folder. Unshare will not work in following cases: The shared folder contains shared folders OR the shared folder is inside another shared folder. | key: unshareFolder

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
Leave a Copy	If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.	false
Shared Folder ID	The ID for the shared folder.	84528192421
Team Member ID	The ID of the team member. Required if Team User Type is set	dbmid:abcd1234
Team User Type	The type of user to connect with. Admin or User

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      ".tag": "complete"
    }
  }
}

Upload File

Upload a file to the specified path | key: uploadFile

Input	Notes	Example
Debug	Whether to log the payload to the debug log. This is useful for troubleshooting.	false
Connection
File Contents	The contents to write to a file. This can be a string of text, it can be binary data (like an image or PDF) that was generated in a previous step.	My File Contents
Path	The location of a file within a Dropbox share. Include a leading /.	/path/to/file.txt

{
  "data": {
    "status": 200,
    "headers": {},
    "result": {
      "id": "exampleId",
      "client_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
      "server_modified": "Wed, 01 Jan 2020 00:00:00 GMT",
      "size": 2048,
      "name": "myFileName"
    }
  }
}

Changelog

2025-10-08

Fixed List Changes action losing cursor position on instance update to ensure reliable pagination.

Manage files stored in Dropbox

Description​

API Documentation​

Detecting changes in Dropbox​

Connections​

OAuth 2.0​

Triggers​

New and Updated Files​

Webhook​

Data Sources​

List Folders​

List Shared Folders​

List Team Folders​

Actions​

Copy Object​

Create Folder​

Create Shared Link​

Delete Object​

Download File​

Export File​

Get Current Account​

Get Download Status​

Get File Lock​

Get Metadata for File or Folder​

Get Shared Link File​

Get Shared Metadata for File​

Get Shared Metadata for Folder​

Get Team Members​

Get Temporary Link​

Get Temporary Upload Link​

List Changes​

List Folder​

List Shared Folders​

List Shared Links​

List Team's Folders​

Lock File​

Move Object​

Raw Request​

Save From URL​

Search Files​

Search Folders​

Share Folder​

Unlock File​

Unshare File​

Unshare Folder​

Upload File​

Changelog​

2025-10-08​

Description

API Documentation

Detecting changes in Dropbox

Connections

OAuth 2.0

Triggers

New and Updated Files

Webhook

Data Sources

List Folders

List Shared Folders

List Team Folders

Actions

Copy Object

Create Folder

Create Shared Link

Delete Object

Download File

Export File

Get Current Account

Get Download Status

Get File Lock

Get Metadata for File or Folder

Get Shared Link File

Get Shared Metadata for File

Get Shared Metadata for Folder

Get Team Members

Get Temporary Link

Get Temporary Upload Link

List Changes

List Folder

List Shared Folders

List Shared Links

List Team's Folders

Lock File

Move Object

Raw Request

Save From URL

Search Files

Search Folders

Share Folder

Unlock File

Unshare File

Unshare Folder

Upload File

Changelog

2025-10-08