Skip to content
Try for free
On this page

Integrations

Dropbox

Upload, download, share, and manage files in Dropbox

Use Dropbox to upload and download files, list folder contents, search files and folders, create folders, and manage shared links. The actions also move or rename files and folders. Delete File/Folder moves them to the trash. Select a connected Dropbox credential and the path or item identifier required by the action.

OAuth scopes

Sim requests these scopes when someone connects a Dropbox account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

SettingValue
Redirect URI<NEXT_PUBLIC_APP_URL>/api/auth/oauth2/callback/dropbox
Environment variablesDROPBOX_CLIENT_ID, DROPBOX_CLIENT_SECRET
ScopeDescription
account_info.readView Dropbox account information
files.metadata.readView file and folder names, sizes, and dates
files.metadata.writeModify file and folder metadata
files.content.readDownload and read Dropbox files
files.content.writeUpload, copy, move, and delete files in Dropbox
sharing.readView shared files and folders
sharing.writeShare files and folders with others

Use the block

Upload and download files, list folder contents, search files and folders, create folders, manage shared links, and move items between folders or to the trash.

Actions

Dropbox Upload File

Upload a file to Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path in Dropbox where the file should be saved (e.g., /folder/document.pdf)
filefileNoThe file to upload (UserFile object)
fileNamestringNoOptional filename (used if path is a folder)
modestringNoWrite mode: add (default) or overwrite
autorenamebooleanNoIf true, rename the file if there is a conflict
mutebooleanNoIf true, don't notify the user about this upload

Output

ParameterTypeDescription
fileobjectThe uploaded file metadata
↳ idstringUnique identifier for the file
↳ namestringName of the file
↳ path_displaystringDisplay path of the file
↳ path_lowerstringLowercase path of the file
↳ sizenumberSize of the file in bytes
↳ client_modifiedstringClient modification time
↳ server_modifiedstringServer modification time
↳ revstringRevision identifier
↳ content_hashstringContent hash for the file

Dropbox Download File

Download a file from Dropbox with metadata

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path of the file to download (e.g., /folder/document.pdf)

Output

ParameterTypeDescription
filefileDownloaded file stored in execution files
metadatajsonThe file metadata
temporaryLinkstringTemporary link to download the file (valid for ~4 hours)

Dropbox List Folder

List the contents of a folder in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path of the folder to list (use "" for root)
recursivebooleanNoIf true, list contents recursively
includeDeletedbooleanNoIf true, include deleted files/folders
includeMediaInfobooleanNoIf true, include media info for photos/videos
limitnumberNoMaximum number of results to return (default: 500)

Output

ParameterTypeDescription
entriesarrayList of files and folders in the directory
↳ idstringUnique identifier
↳ namestringName of the file/folder
↳ path_displaystringDisplay path
↳ sizenumberSize in bytes (files only)
cursorstringCursor for pagination
hasMorebooleanWhether there are more results

Dropbox Create Folder

Create a new folder in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path where the folder should be created (e.g., /new-folder)
autorenamebooleanNoIf true, rename the folder if there is a conflict

Output

ParameterTypeDescription
folderobjectThe created folder metadata
↳ idstringUnique identifier for the folder
↳ namestringName of the folder
↳ path_displaystringDisplay path of the folder
↳ path_lowerstringLowercase path of the folder

Dropbox Delete

Delete a file or folder in Dropbox (moves to trash)

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path of the file or folder to delete

Output

ParameterTypeDescription
metadataobjectMetadata of the deleted item
↳ namestringName of the deleted item
↳ path_displaystringDisplay path
deletedbooleanWhether the deletion was successful

Dropbox Copy

Copy a file or folder in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
fromPathstringYesThe source path of the file or folder to copy
toPathstringYesThe destination path for the copied file or folder
autorenamebooleanNoIf true, rename the file if there is a conflict at destination

Output

ParameterTypeDescription
metadataobjectMetadata of the copied item
↳ idstringUnique identifier
↳ namestringName of the copied item
↳ path_displaystringDisplay path
↳ sizenumberSize in bytes (files only)

Dropbox Move

Move or rename a file or folder in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
fromPathstringYesThe source path of the file or folder to move
toPathstringYesThe destination path for the moved file or folder
autorenamebooleanNoIf true, rename the file if there is a conflict at destination

Output

ParameterTypeDescription
metadataobjectMetadata of the moved item
↳ idstringUnique identifier
↳ namestringName of the moved item
↳ path_displaystringDisplay path
↳ sizenumberSize in bytes (files only)

Dropbox Get Metadata

Get metadata for a file or folder in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path of the file or folder to get metadata for
includeMediaInfobooleanNoIf true, include media info for photos/videos
includeDeletedbooleanNoIf true, include deleted files in results

Output

ParameterTypeDescription
metadataobjectMetadata for the file or folder
↳ idstringUnique identifier
↳ namestringName of the item
↳ path_displaystringDisplay path
↳ path_lowerstringLowercase path
↳ sizenumberSize in bytes (files only)
↳ client_modifiedstringClient modification time (files only)
↳ server_modifiedstringServer modification time (files only)
↳ revstringRevision identifier (files only)
↳ content_hashstringContent hash (files only)

Dropbox Create Shared Link

Create a shareable link for a file or folder in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path of the file or folder to share
requestedVisibilitystringNoVisibility: public, team_only, or password
linkPasswordstringNoPassword for the shared link (only if visibility is password)
expiresstringNoExpiration date in ISO 8601 format (e.g., 2025-12-31T23:59:59Z)

Output

ParameterTypeDescription
sharedLinkobjectThe created shared link
↳ urlstringThe shared link URL
↳ namestringName of the shared item
↳ path_lowerstringLowercase path of the shared item
↳ expiresstringExpiration date if set
↳ link_permissionsobjectPermissions for the shared link

Dropbox List Shared Links

List shared links for a path, or for the entire account if no path is given

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringNoPath to list shared links for. If omitted, lists all shared links.
directOnlybooleanNoIf true, only return links directly to the path, not parent folder links
cursorstringNoCursor from a previous call to fetch the next page of results

Output

ParameterTypeDescription
linksarrayShared links applicable to the path argument
↳ urlstringThe shared link URL
↳ namestringName of the shared item
↳ path_lowerstringLowercase path of the shared item
↳ expiresstringExpiration date if set
hasMorebooleanWhether there are more results
cursorstringCursor for pagination (only returned when no path is given)

Dropbox Search

Search for files and folders in Dropbox

Inputs and outputs

Input

ParameterTypeRequiredDescription
querystringYesThe search query
pathstringNoDropbox folder path to limit search scope (e.g., /folder/subfolder)
fileExtensionsstringNoComma-separated list of file extensions to filter by (e.g., pdf,xlsx)
maxResultsnumberNoMaximum number of results to return (default: 100)

Output

ParameterTypeDescription
matchesarraySearch results
↳ match_typeobjectType of match: filename, content, or both
↳ metadataobjectFile or folder metadata
hasMorebooleanWhether there are more results
cursorstringCursor for pagination

Dropbox List Revisions

List the revision history for a file in Dropbox (files only, not folders)

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path of the file to list revisions for
limitnumberNoMaximum number of revisions to return, 1-100 (default: 10)
beforeRevstringNoOnly return revisions before this one. Pass the rev of the last revision from a previous call to fetch the next page.

Output

ParameterTypeDescription
entriesarrayThe revisions for the file, most recent first
↳ idstringUnique identifier for this revision
↳ namestringName of the file
↳ path_displaystringDisplay path
↳ revstringRevision identifier, pass to Restore
↳ sizenumberSize of this revision in bytes
↳ server_modifiedstringServer modification time
isDeletedbooleanWhether the file identified by the latest revision is deleted or moved
hasMorebooleanWhether there are more revisions available

Dropbox Restore

Restore a specific revision of a file to the given path

Inputs and outputs

Input

ParameterTypeRequiredDescription
pathstringYesThe path to save the restored file to
revstringYesThe revision identifier to restore (from Dropbox List Revisions)

Output

ParameterTypeDescription
metadataobjectMetadata of the restored file
↳ idstringUnique identifier for the file
↳ namestringName of the file
↳ path_displaystringDisplay path of the file
↳ path_lowerstringLowercase path of the file
↳ sizenumberSize of the file in bytes
↳ revstringRevision identifier of the restored file
↳ server_modifiedstringServer modification time
Was this helpful?
Suggest an edit