Documentation Index

Fetch the complete documentation index at: https://docs.lansweeper.com/llms.txt

Use this file to discover all available pages before exploring further.

Dropbox Connector

Prev Next
Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

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

Connections

OAuth 2.0

OAuth 2.0 Connectivity for Dropbox

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:

  1. Select Create app.
  2. Select that you want Scoped access.
  3. 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.
  4. 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.
  5. Under the OAuth2 section add the Redirect URI as https://oauth2.flowbuilder.eu.lansweeper.com/callback for EU sites or https://oauth2.flowbuilder.us.lansweeper.com/callback for US sites.

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.

Production Approval

Dropbox requires third-party OAuth apps to pass a production approval review. Dropbox OAuth apps start in development mode, which are fully functional but limited to 50 total linked users. These apps may be used to build, test, and deploy integrations in this state.

Dropbox apps pass through two states before they are ready for broad deployment.

Development mode (default): New apps start in development mode, limited to 50 total linked users. The OAuth authorization flow works normally for users within this limit. No warning is shown during authentication. Once the app reaches 50 linked users, it is frozen: new users cannot authenticate and the authorization flow returns an error to anyone attempting to connect.

Production approved: Any Dropbox user can authorize the integration without restriction. No warning is shown.

Submit for production approval before broadly deploying the integration to end users. Once an app reaches 50 linked users, Dropbox opens a two-week window to apply for approval. If approval is not granted within this window, the app is frozen: new users cannot authenticate, and the app cannot be unfrozen by unlinking existing users. Production approval is the only path forward once frozen.

The recommended approach: deploy to a small initial group to reach the 50 linked users required for review eligibility, then apply for approval immediately and refrain from waiting to scale broadly.

Apps used solely for internal purposes can remain in development mode and do not require production approval.

Applying for Production Approval

  1. Open the Dropbox App Console and select the app
  2. On the app's info page, click Apply for Production
  3. Provide the following details (more detail leads to faster review):
    • A description of how the app uses the Dropbox API
    • An app icon
    • A functional description of the integration

Applications are not reviewed until the app has at least 50 linked users. Early review is possible by providing a compelling justification when applying.

App Name Is Locked After Approval

The app name cannot be changed after production approval is granted. Finalize the app name before submitting.

Refer to the Dropbox developer guide for full production approval requirements.

This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.

Input Comments Default
App Key Generate in the Dropbox Developer Portal.
App Secret Generate in the Dropbox Developer Portal.

Triggers

New and Updated Files

Checks for new and updated files on a configured schedule.

Input Comments Default
Connection
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Recursive If true, the response will contain contents of all subfolders. false
Include Deleted? If true, the results will include entries for files and folders that used to exist but were deleted. false
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Webhook

Receive and validate webhook requests from Dropbox for webhooks you configure.

Input Comments Default
Signing Secret The 'App Secret' of your Dropbox app

Actions

Copy Object

Copy a Folder or File from one path to another

Input Comments Default
Connection
From Path The location of a source file within a Dropbox share. Include a leading /.
To Path The location of a destination file within a Dropbox share. Include a leading /.

Create Folder

Create a Folder at the specified path

Input Comments Default
Connection
Path The location of a file within a Dropbox share. Include a leading /.

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).

Input Comments Default
Connection
Path The location of a file within a Dropbox share. Include a leading /.
Require Password Boolean flag to enable or disable password protection. false
Link Password If the shared link has a password, this parameter can be used.
Expires Expiration time of the shared link. By default the link won't expire.
Audience
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
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Delete Object

Delete a Folder or File at the specified path

Input Comments Default
Connection
Path The location of a file within a Dropbox share. Include a leading /.

Download File

Download the file (< 150MB) at the specified path

Input Comments Default
Connection
Path The location of a file within a Dropbox share. Include a leading /.
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

Export File

Export the file at the specified path

Input Comments Default
Connection
Directory Path The path of the file to be exported.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Get Current Account

Get information about the currently authenticated user

Input Comments Default
Connection

Get Download Status

Get the status of a file download from a URL to Dropbox

Input Comments Default
Connection
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.

Get File Lock

Return the lock metadata for the given list of paths

Input Comments Default
Connection
Team Member ID Used to specify the user to act on behalf of.
File Path This represents the source files's path. Include a leading / (Use this, Dynamic Paths or both)
Dynamic Paths An optional list of paths (Use this, File Paths or both)

Get Metadata for File or Folder

Returns the metadata for a file or folder.

Input Comments Default
Connection
Path The path of a file or folder on Dropbox to get metadata for
Include Media Info If true, FileMetadata.media_info is set for photo and video. false
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
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Get Shared Link File

Download the shared link's file from a user's Dropbox.

Input Comments Default
Connection
Shared Link URL StringURL of the shared link.
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.
Link Password If the shared link has a password, this parameter can be used.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Get Shared Metadata for File

Returns shared file metadata.

Input Comments Default
Connection
File Id The ID for the shared file.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Get Shared Metadata for Folder

Returns shared folder metadata.

Input Comments Default
Connection
Shared Folder ID The ID of the shared folder to retrieve metadata for
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Get Team Members

Get Team Members by Member ID, External ID, or Email

Input Comments Default
Connection
Lookup By
Value

Get Temporary Link

Get a temporary link to stream content of a file.

Input Comments Default
Connection
Path The path to the file you want a temporary link to
Team Member ID Used to specify the user to act on behalf of.

Get Temporary Upload Link

Get a temporary presigned link to upload a file

Input Comments Default
Connection
Path The location of a file within a Dropbox share. Include a leading /.
Duration How long the link will be valid, in seconds. Defaults to 1 hour. 3600

List Changes

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

Input Comments Default
Connection
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Recursive If true, the response will contain contents of all subfolders. false
Include Deleted? If true, the results will include entries for files and folders that used to exist but were deleted. false
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

List Folder

List Folder contents at the specified path

Input Comments Default
Connection
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Recursive If true, the response will contain contents of all subfolders. false
Fetch All When enabled, automatically fetches all pages of results. Cursor and Limit inputs are ignored when this is enabled. false
Cursor Specify the cursor returned by your last call to list_folder or list_folder/continue.
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.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

List Shared Folders

List Shared Folders contents

Input Comments Default
Connection
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Folder Actions A list of FolderActions corresponding to FolderPermissions 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.
Fetch All When enabled, automatically fetches all pages of results. Cursor and Limit inputs are ignored when this is enabled. false
Cursor Specify the cursor returned by your last call to list_folder or list_folder/continue.
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.

List Shared Links

List Folder contents at the specified path

Input Comments Default
Connection
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Direct Only Links to parent folders can be suppressed by setting direct_only to true. false
Fetch All When enabled, automatically fetches all pages of results. Cursor and Limit inputs are ignored when this is enabled. false
Cursor Specify the cursor returned by your last call to list_folder or list_folder/continue.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

List Team's Folders

List Team's Folder contents

Input Comments Default
Connection
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Fetch All When enabled, automatically fetches all pages of results. Cursor and Limit inputs are ignored when this is enabled. false
Cursor Specify the cursor returned by your last call to list_folder or list_folder/continue.
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.

Lock File

Lock the files at the given paths

Input Comments Default
Connection
Team Member ID Used to specify the user to act on behalf of.
File Path This represents the source files's path. Include a leading / (Use this, Dynamic Paths or both)
Dynamic Paths An optional list of paths (Use this, File Paths or both)

Move Object

Move a Folder or File from one path to another

Input Comments Default
Connection
From Path The location of a source file within a Dropbox share. Include a leading /.
To Path The location of a destination file within a Dropbox share. Include a leading /.

Raw Request

Send raw HTTP request to Dropbox

Input Comments Default
Connection
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set
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.
Method The HTTP method to use.
Data The HTTP body payload to send to the URL.
Form Data The Form Data to be sent as a multipart form upload.
File Data File Data to be sent as a multipart form upload.
File Data File Names File names to apply to the file data inputs. Keys must match the file data keys above.
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.
Header A list of headers to send with the request.
Response Type The type of data you expect in the response. You can request json, text, or binary data. json
Timeout The maximum time that a client will await a response to its request
Retry Delay (ms) The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. 0
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
Max Retry Count The maximum number of retries to attempt. Specify 0 for no retries. 0
Use Exponential Backoff Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. false

Save From URL

Save a file from a URL to Dropbox

Input Comments Default
Connection
To Path The path with file name with extension where the URL will be saved to in Dropbox.
URL to Save The URL to save to Dropbox
Wait Until Complete Whether to wait for the operation to complete. false

Search Files

Search for files at the specified path

Input Comments Default
Connection
File Name The name of a file within a Dropbox share.
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Fetch All When enabled, automatically fetches all pages of results. Cursor and Limit inputs are ignored when this is enabled. false
Cursor Specify the cursor returned by your last call to list_folder or list_folder/continue.
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.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Search Folders

Search for folders at the specified path

Input Comments Default
Connection
Folder Name The name of the folder to search for
Directory Path The path to a directory within a Dropbox share. Include a leading /.
Fetch All When enabled, automatically fetches all pages of results. Cursor and Limit inputs are ignored when this is enabled. false
Cursor Specify the cursor returned by your last call to list_folder or list_folder/continue.
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.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Share Folder

Share a folder with collaborators. Most sharing will be completed synchronously. Large folders will be completed asynchronously.

Input Comments Default
Connection
Directory Path The path or the file id to the folder to share. If it does not exist, then a new one is created.
ACL Update Policy Who can add and remove members of this shared folder.
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.
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.
Viewer Info Policy Who can enable/disable viewer info for this shared folder.
Access Inheritance The access inheritance settings for the folder.
Actions A list of FolderActions corresponding to FolderPermissions that should appear in the response's SharedFolderMetadata.permissions field describing the actions the authenticated user can perform on the folder. []
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Unlock File

Unlock the files at the given paths

Input Comments Default
Connection
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set
File Path This represents the source files's path. Include a leading / (Use this, Dynamic Paths or both)
Dynamic Paths An optional list of paths (Use this, File Paths or both)

Unshare File

Remove all members from this file. Does not remove inherited members.

Input Comments Default
Connection
File Id The ID for the shared file.
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

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.

Input Comments Default
Connection
Shared Folder ID The ID for the shared folder.
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
Team User Type The type of user to connect with. Admin or User
Team Member ID The ID of the team member. Required if Team User Type is set

Upload File

Upload a file to the specified path

Input Comments Default
Connection
Path The location of a file within a Dropbox share. Include a leading /.
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.