Dropbox is a cloud storage service offering file syncing, sharing, and collaboration across devices with version control and robust integrations
Dropbox is a cloud storage service offering file syncing, sharing, and collaboration across devices with version control and robust integrations On Nagent, Dropbox is exposed as a fully-configurable file management & storage integration that any agent can call — 177 actions, and OAuth authentication. No code is required to wire Dropbox into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Dropbox to automate the kinds of tasks file management & storage teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Dropbox into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Dropbox, with input parameters and output schema. Drop these into any step of an agent built in Helix.
DROPBOX_ACTIVATE_TEAM_FOLDERTool to activate an archived team folder. Use when you need to restore access to a previously archived team folder.
Input parameters
The ID of the team folder to activate.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_FILE_MEMBERTool to add specified members to a Dropbox file with configurable access levels. Use when sharing a file with specific users by email or Dropbox ID. Supports custom invitation messages and notification controls. Note: This endpoint does not support apps with the app folder permission, and members will receive invitations unless quiet mode is enabled.
Input parameters
File to which to add members. Use the file ID format (e.g., 'id:7bh4zBmgZoAAAAAAAAABCQ') or file path.
Whether to suppress device notifications for added members. If false (default), members will be notified of their invitation.
List of members to add to the file. Each member is identified by email or Dropbox ID. Note: If an email is provided and it's the user's main account email, they may be directly added to the membership.
Defines the access level for the new member.
Custom message to include in the invitation email sent to added members.
If true and a custom_message is provided, the message will be added as a comment on the file.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_FILE_PROPERTIESTool to add custom properties to a Dropbox file using a filled property template. Use when you need to tag files with structured metadata like project info, status, or categories.
Input parameters
A unique identifier for the file or folder. Can be a file path (e.g., '/test.txt') or a file ID (e.g., 'id:a4ayc_80_OEAAAAAAAAAXw').
The property groups to be added to the Dropbox file. Each group must reference a valid template that the file doesn't already have.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_FILE_TAGSTool to add a tag to a file or folder in Dropbox. Use when you need to tag items for organization. Tags are automatically converted to lowercase.
Input parameters
Path to the file or folder to tag. Must be a valid path in the user's Dropbox.
The tag text to add. Will be automatically converted to lowercase letters by Dropbox.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_FOLDER_MEMBER_ACTIONTool to add members to a shared folder with specified access levels. Use when an owner or editor needs to invite new members to a shared folder. Members receive invites and must be mounted via mount_folder for full access. Requires appropriate ACL permissions.
Input parameters
Whether to suppress email and device notifications for the added members. If true, members are added silently without notification. Default is false
List of members to add to the shared folder. Each member will receive an invitation to join the folder
Optional custom message to include in the invitation email sent to added members
The ID of the shared folder to add members to. You can get this from list_shared_folders action
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_MEMBER_SPACE_LIMITS_EXCLUDED_USERSTool to add users to the team's space limits exclusion list in Dropbox. Users on this list are exempt from space limit restrictions. Use when you need to exclude specific team members from storage quota enforcement. Requires team admin authentication.
Input parameters
List of users to be added to the space limits exclusion list. Each user can be specified by team_member_id, external_id, or email. Maximum size of the list is 1000 users.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_SHARING_ALLOWLISTTool to add domains or email addresses to the team sharing allowlist. Use when team admins need to approve specific domains or emails for sharing. Requires team admin authentication. At least one of 'domains' or 'emails' must be provided, with a maximum of 100 entries per call.
Input parameters
List of email addresses to add to the allowlist. Each email must be a valid string representation following RFC-5322/822 (e.g., 'user@example.com'). Maximum 100 entries per call. At least one of 'domains' or 'emails' must be provided
List of domains to add to the allowlist. Each domain must be a valid string representation following RFC-1034/5 (e.g., 'example.com', 'subdomain.example.org'). Maximum 100 entries per call. At least one of 'domains' or 'emails' must be provided
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_TEAM_GROUP_MEMBERSTool to add members to a team group with specified access levels. Use when you need to add users to an existing team group. Requires team admin credentials with group management permissions.
Input parameters
The group to add members to. Use group_id obtained from list_team_groups or create_team_group actions
List of members to add to the group with their respective access levels
Whether to return the list of members in the group after adding. Default is true
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_TEAM_MEMBERSTool to add new members to a Dropbox team. Use when you need to invite users to join the team with specified roles and settings. Maximum of 20 members per request. Requires team admin credentials.
Input parameters
Whether to force the operation to happen asynchronously. If true, returns an async_job_id to poll for completion. Default is false
List of new members to add to the team. Maximum of 20 members per request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_TEAM_MEMBERS_SECONDARY_EMAILSTool to add secondary email addresses to Dropbox team members. Use when you need to associate additional email addresses with team member accounts. Requires team admin credentials.
Input parameters
List of users and their secondary emails to add. Each entry specifies a user (by ID or email) and the secondary emails to add for them
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ADD_TEAM_PROPERTIES_TEMPLATETool to add a property template for a team in Dropbox. Use when you need to create a standardized set of custom properties that can be applied to files and folders. Requires team admin permissions and a Dropbox Business account.
Input parameters
Display name for the template. Template names can be up to 256 bytes.
Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.
Description for the template. Template descriptions can be up to 1024 bytes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ALPHA_UPLOAD_FILETool to upload a new file to Dropbox using the alpha upload endpoint. Use when uploading files up to 150 MiB. Note that the behavior of this alpha endpoint is unstable and subject to change.
Input parameters
Selects what to do if the file already exists.
If true, this tells the clients that this modification shouldn't result in a user notification.
Path in the user's Dropbox to save the file. Must start with '/' and include the filename.
File to be uploaded. Supports various formats including text, images, and PDFs.
If there's a conflict as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
The value to store as the client_modified timestamp in ISO 8601 format (e.g., '2015-05-12T15:50:38Z'). Dropbox automatically records the time at which the file was written to the Dropbox servers.
List of custom properties to add to file.
Optional. For team accounts: Dropbox account ID or team member ID to operate on. Required when using a Dropbox Business team token. Format: 'dbid:...' or team_member_id.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_APPEND_UPLOAD_SESSIONTool to append more data to an existing upload session. Use when uploading large files in chunks. When the 'close' parameter is set to true, this call will close the session. A single request should not upload more than 150 MiB.
Input parameters
If true, the upload session will be closed after appending this data. Once closed, no more data can be appended to the session.
Cursor information containing the session_id and current offset in bytes.
File data to append to the upload session.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_APPEND_UPLOAD_SESSION_BATCHTool to append data to multiple upload sessions in a single request. Use when you need to upload data to multiple ongoing upload sessions efficiently. The file content for each session should be concatenated in the request body in the order specified by entries. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2^41 - 2^22 (2,199,019,061,248) bytes.
Input parameters
Concatenated binary data for all upload sessions. The data for each session should be concatenated in the order specified in the entries list. Each chunk's length must match the corresponding entry's length field.
List of upload session entries to append data to. Each entry specifies the session, how many bytes to read from the request body, and whether to close the session. The data for each entry should be concatenated in the request body in the same order as this list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_ARCHIVE_TEAM_FOLDERTool to archive an active team folder in Dropbox. Sets the team folder's status to archived and removes all folder and file members. Use when you need to archive a team folder that is no longer in active use. The folder must be active before it can be archived.
Input parameters
The ID of the team folder to archive. You can get this from list team folders action. The team folder must be active to be archived.
Whether to force the operation to run synchronously. If true, the operation will complete synchronously and return metadata immediately. If false or not specified, large operations may complete asynchronously.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_COPY_BATCHTool to check the status of an asynchronous copy batch job in Dropbox. Use when you have an async_job_id from a previous copy_batch operation and need to poll its status. Returns 'in_progress', 'complete' with results for each entry, or 'failed' with error details.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_DELETE_BATCHTool to check the status of an asynchronous delete batch job in Dropbox. Use when you need to poll the status of a batch delete operation initiated by delete_batch. Returns 'in_progress', 'complete' with per-entry results, 'failed', or error status.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_FOLDER_BATCHTool to check the status of an asynchronous folder batch creation job. Use when you need to poll the status of a create_folder_batch operation. Returns 'in_progress', 'complete' with results, or 'failed' with error details.
Input parameters
ID of the asynchronous job. This is the value returned from the create_folder_batch method.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_JOB_STATUSTool to check the status of an asynchronous sharing job in Dropbox. Use when you have an async_job_id from a previous sharing operation (like unshare_folder, remove_folder_member) and need to poll its status. Returns 'in_progress', 'complete', 'failed' with error details, or polling errors.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_MOVE_BATCHTool to check the status of an asynchronous move batch job. Use when you need to poll the status of a batch move operation started with move_batch_v2. Returns a list of results for each entry when complete.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_MOVE_FORMER_MEMBER_FILES_JOB_STATUSTool to check the status of an asynchronous move former member files job. Use when you have an async_job_id from a previous team/members/move_former_member_files operation and need to poll its completion status. Returns 'in_progress', 'complete', 'failed' with error details, or error states like 'invalid_async_job_id'.
Input parameters
Id of the asynchronous job returned from team/members/move_former_member_files. This is used to poll the status of the file move operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_REMOVE_MEMBERTool to check the status of an asynchronous remove folder member job in Dropbox. Use when you have an async_job_id from a previous remove_folder_member operation and need to poll its status. Returns 'in_progress', 'complete' with access level info, or 'failed' with error details.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_SAVE_URL_STATUSTool to check the status of a save_url job in Dropbox. Use when you have an async_job_id from a save_url operation and need to poll its completion status. Returns 'in_progress', 'complete' with file metadata, or 'failed' with error details.
Input parameters
The async job ID returned from a previous save_url operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_SHARE_JOB_STATUSTool to check the status of an asynchronous folder sharing job in Dropbox. Use when you need to poll the status of a folder share operation that was initiated asynchronously. Returns 'in_progress', 'complete' with folder metadata, 'failed' with error details, or polling error status.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_TEAM_FOLDER_ARCHIVETool to check the status of an asynchronous team folder archive job in Dropbox. Use when you have an async_job_id from a previous team_folder/archive operation and need to poll its status. Returns 'in_progress' while archiving, 'complete' with team folder metadata when done, or error states like 'invalid_async_job_id'.
Input parameters
Id of the asynchronous job returned from the team_folder/archive method that launched the archive operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_UPLOAD_BATCHTool to check the status of an asynchronous upload batch job in Dropbox. Use when you need to poll the status of a batch upload operation initiated by upload_session/finish_batch. Returns 'in_progress', 'complete' with per-entry results, or error status.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CHECK_USERTool to test Dropbox API connection and validate access token by echoing back a supplied string. Use when you need to verify that the Dropbox API is accessible and the access token is valid.
Input parameters
The string that you'd like to be echoed back to you. Maximum length is 500 characters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_COPY_BATCHTool to copy multiple files or folders to different locations at once in Dropbox. Use when you need to duplicate multiple items efficiently. This operation may complete synchronously or return a job ID for async processing. Use copy_batch/check:2 to check async job status.
Input parameters
List of entries to be copied. Each entry is a RelocationPath with from_path and to_path.
If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict. The default is false.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_COPY_FILE_OR_FOLDERTool to copy a file or folder to a different location in Dropbox. Use when you need to duplicate content without removing the original. If the source path is a folder, all its contents will be copied.
Input parameters
Path in the user's Dropbox that is the destination. This path is case-sensitive.
Path in the user's Dropbox to be copied. This path is case-sensitive.
If there's a conflict (e.g., a file with the same name already exists at the destination), have the Dropbox server try to auto-rename the file to avoid the conflict. The default is false.
If true, allows copying of shared folders. Note: This flag has no effect in current API version. The default is false.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Allow moves by owner even if it would result in an ownership transfer for the content being moved. Note: This does not apply to copies. The default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_COUNT_FILE_REQUESTSTool to get the total number of file requests owned by the authenticated user. Use when you need to count how many file requests (both open and closed) exist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_FILE_REQUESTTool to create a new file request in Dropbox. Use when you need to request files from others by generating a unique link for uploads to a specified Dropbox folder, optionally with a deadline.
Input parameters
Whether the file request should be open by default. If true, the file request will start accepting files immediately.
The title of the new file request. Must be 1 character or more.
Represents the deadline parameters for a file request.
The path in the user's Dropbox where uploaded files will be saved. Must be a path starting with '/'. Example: '/Homework/math'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_FOLDERTool to create a new folder at a specified path in Dropbox. Use when you need to organize files by creating a new directory.
Input parameters
Path in the user's Dropbox to create the folder. Must start with a slash. May use 'id:' prefix for namespace-based paths. Must not end with '/' or whitespace. Paths are case-insensitive but must be correctly formatted to avoid validation errors.
If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. Default is False. Without autorename, a conflict returns a `path_conflict` error. For idempotent folder creation, set autorename=true or treat `path_conflict` as non-fatal.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_FOLDER_BATCHTool to create multiple folders at once in Dropbox. Use when you need to create several folders efficiently in a single request. For large batches, returns a job ID immediately and runs asynchronously; for smaller inputs, creates folders and returns results synchronously.
Input parameters
List of paths to be created in the user's Dropbox. Each path must start with a slash. Duplicate path arguments in the batch are considered only once. Maximum 10,000 paths.
If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. Default is False.
Whether to force the create to happen asynchronously. For large batches, the operation will be asynchronous automatically. Default is False.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_PAPER_DOCUMENTCreates a new Dropbox Paper document at the specified path using HTML or Markdown content.
Input parameters
The fully qualified path in Dropbox where the Paper document will be created. MUST include the .paper extension at the end (e.g., '/My Documents/Notes.paper').
Content of the paper document
Format of the provided content
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_PAPER_FOLDERTool to create a new Paper folder with the provided info. Use when you need to organize Paper documents by creating a new folder. Note: This endpoint works for content created by users on the older version of Paper.
Input parameters
The name of the new Paper folder.
Whether the folder to be created should be a team folder. If not specified, defaults to false.
The encrypted Paper folder Id where the new Paper folder should be created. If not provided, the folder will be created at the root level.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_SHARED_LINKTool to create a stable, long-lived shared link for a Dropbox file or folder. Use when the user needs a permanent URL suitable for embedding or long-term sharing (as opposed to temporary links that expire in hours). Supports optional settings like expiration, password protection, and visibility controls. Note: If a shared link already exists for the path, the API will return an error; in that case, use a separate list_shared_links endpoint to retrieve existing links.
Input parameters
The path or file identifier to be shared by the shared link. Supports Dropbox path (e.g., '/folder/file.txt'), id:..., rev:..., or ns:... notation.
Settings for the shared link configuration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_SHARED_LINK_SIMPLEDEPRECATED: Use CreateSharedLinkV2 instead. Tool to create a basic shared link for a Dropbox file or folder. If a shared link already exists for the given path, that link is returned. Use when you need a simple shared link without advanced settings like password protection or custom expiration. For links with advanced settings, use the create_shared_link action instead.
Input parameters
The path to share. This can be a file or folder path in Dropbox (e.g., '/folder/file.txt'). If a shared link already exists for this path, that link will be returned instead of creating a new one.
Whether to return a shortened URL. If true, the returned URL will be shorter and easier to share.
Mode for pending upload indicating file or folder type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_TEAM_FOLDERTool to create a new, active team folder with no members in Dropbox. Use when you need to set up a new team folder for collaboration. The folder is created without any members initially.
Input parameters
Name for the new team folder. The name must be unique within the team.
Sync setting enum for the team folder.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_CREATE_TEAM_GROUPTool to create a new, empty team group in Dropbox with a specified name. Use when you need to create a new group for organizing team members. Requires team admin credentials with team member management permissions.
Input parameters
The name for the new group. Must not be empty.
An arbitrary external ID that the creator of the team can associate with the group for organizational purposes.
The type of group management for the team group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_ALL_CLOSED_FILE_REQUESTSTool to delete all closed file requests owned by the current user. Use when you need to clean up closed file requests in bulk.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_BATCHTool to delete multiple files or folders at once in Dropbox. Use when you need to delete several items simultaneously. This route is asynchronous and returns a job ID immediately for large batches. Use delete_batch/check to verify completion status.
Input parameters
List of files or folders to delete. Maximum 1000 entries per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_FILETool to delete a file or folder at the specified path in Dropbox. Use when you need to permanently remove a file or folder and all its contents.
Input parameters
Path in the user's Dropbox to delete. The path must start with a slash.
Perform delete if given 'rev' matches the existing file's latest 'rev'. This field does not support deleting a folder.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_FILE_OR_FOLDERDEPRECATED: Use DeleteFile instead. Permanently and irreversibly deletes the file or folder at the specified path in Dropbox. Folder deletion is recursive — all nested contents are removed. Always obtain explicit user confirmation before calling, especially for folders. Requires the `files.content.write` scope.
Input parameters
The path to the file or folder to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_FILE_REQUESTSTool to delete a batch of closed file requests in Dropbox. Use when you need to remove multiple file requests that are no longer needed. Only closed file requests can be deleted; attempting to delete open file requests will fail.
Input parameters
List of file request IDs to delete. Only closed file requests can be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_MANUAL_CONTACTS_BATCHTool to delete specific manually added contacts from Dropbox by their email addresses. Use when you need to remove contacts that were manually added to a user's Dropbox account.
Input parameters
List of email addresses of manually added contacts to delete. Must be valid email addresses.
Team member ID (format: dbmid:...) to specify which team member's contacts to delete. Required when using team OAuth tokens. Optional for individual accounts.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_TEAM_FOLDER_PERMANENTLYTool to permanently delete an archived team folder in Dropbox. Use when you need to permanently remove an archived team folder and all its contents. The team folder must be archived before it can be permanently deleted.
Input parameters
The ID of the team folder to permanently delete. The team folder must be archived before it can be permanently deleted. You can get this from list team folders action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_TEAM_GROUPTool to delete a Dropbox team group. Use when you need to remove a team group. Note that this requires team admin permissions and the group cannot be system-managed.
Input parameters
The Dropbox group ID. Required when selector_type is 'group_id'. Example: 'g:e18cdeb8c1e9c0280000000000000053'
The type of selector to use for identifying the group. 'group_id' - Select group by Dropbox group ID. 'group_external_id' - Select group by external ID.
The external ID of the group. Required when selector_type is 'group_external_id'. This is the ID from an external system that has been associated with the Dropbox group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_TEAM_MEMBER_PROFILE_PHOTOTool to delete a team member's profile photo. Use when you need to remove the profile picture of a team member. Requires team admin permissions.
Input parameters
The team member whose profile photo should be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DELETE_TEAM_MEMBERS_SECONDARY_EMAILSTool to delete secondary email addresses from Dropbox team members. Use when you need to remove secondary emails from one or more team members. Requires team member management permissions.
Input parameters
List of users and their secondary emails to delete. Each entry specifies a user and which secondary emails to remove from that user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_DOWNLOAD_ZIPTool to download a folder from Dropbox as a zip file. Use when you need to download an entire folder structure with multiple files. The folder must be less than 20 GB in size with any single file less than 4 GB, and the resulting zip must have fewer than 10,000 total entries.
Input parameters
The path to the folder to download as a zip file. Must be a folder path, not a single file. The folder must be less than 20 GB in size with any single file less than 4 GB. The resulting zip must have fewer than 10,000 total file and folder entries.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_EXPORT_FILETool to export non-downloadable Dropbox files (especially Dropbox Paper) to Markdown/HTML/plain text and return usable content. Use when you need to access content from files that cannot be downloaded directly, such as Dropbox Paper documents or Google Docs stored in Dropbox. Requires files.content.read scope.
Input parameters
'return_text': return exported text directly (truncated safely if very large). 'store_and_link': create a temporary Dropbox download link to the original file.
The path of the file to be exported. Supports Dropbox path (e.g., '/folder/file.paper'), id:..., rev:..., or ns:... notation. Use this for non-downloadable files like Dropbox Paper documents.
The file format to export to. Common values: 'markdown', 'html', 'plain_text'. If not specified, the default format for the file type will be used. For Dropbox Paper, default is 'markdown'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_FILES_SEARCHTool to search for files and folders in Dropbox by name or content. Use when you need to find items matching a search query within a specific path or across the entire Dropbox.
Input parameters
Search mode for Dropbox files search.
The path in the user's Dropbox to search. Should probably be a folder. Use empty string to search the entire Dropbox.
The string to search for. The search string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (e.g., 'bat c' matches 'bat cave' but not 'batman car').
The starting index within the search results (used for paging). Default is 0.
The maximum number of search results to return. Default is 100, max is 1000.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_FINISH_UPLOAD_SESSIONTool to finish an upload session and save the uploaded data to the given file path. Use when completing a multi-part upload after using upload_session/start and upload_session/append. A single request should not upload more than 150 MiB. The maximum size of a file one can upload to an upload session is 2,199,019,061,248 bytes.
Input parameters
Contains the path and other optional modifiers for the commit.
Cursor information containing the session_id and current offset in bytes.
Final file data to append before finishing the session. Can be omitted if no additional data needs to be appended.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_FINISH_UPLOAD_SESSION_BATCHTool to commit many files at once into a user's Dropbox after uploading file contents via upload_session/start and upload_session/append. Use when you need to finish multiple upload sessions in a single request. Returns an async_job_id which can be used with upload_session/finish_batch/check to poll for completion. Maximum 1000 entries per request.
Input parameters
List of upload sessions to finish. Each entry contains cursor information and commit parameters. Maximum 1000 entries per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_ABOUT_METool to get information about the current user's Dropbox account. Use when you need to retrieve account details like email, name, or account type. Useful for verifying authenticated account identity before destructive operations in multi-account setups. Note: successful response does not imply access to all shared or team folders; path-specific permission errors from other tools indicate missing folder-level permissions, not empty results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_ACCOUNTTool to get information about a user's Dropbox account using their account ID. Use when you need to retrieve account details for a specific user.
Input parameters
A user's account identifier. Can be obtained from get_current_account endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_ACCOUNT_BATCHTool to get information about multiple user accounts in a single request. At most 300 accounts may be queried per request. Use when you need to retrieve details for multiple Dropbox users efficiently.
Input parameters
List of user account identifiers. Should not contain any duplicate account IDs. Maximum 300 accounts per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_AVAILABLE_TEAM_MEMBER_ROLESTool to retrieve all available team member roles for the connected Dropbox team. Use when you need to discover what roles can be assigned to team members (e.g., Team, Billing, Report, Content, Security, User management, Support).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_COPY_REFERENCETool to get a copy reference to a file or folder. Use when you need to generate a reference string that can be used to copy the file or folder to another user's Dropbox via copy_reference/save.
Input parameters
The path to the file or folder you want to get a copy reference to. This path is case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_FILE_LOCK_BATCHTool to return lock metadata for multiple files in a single batch request. Use when you need to check the lock status of up to 1000 files at once.
Input parameters
List of files to check lock status for. Maximum 1000 entries per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_FILE_METADATA_BATCHTool to retrieve metadata for multiple shared files in a single batch request. Use when you need to get information about shared file permissions, access levels, owners, and sharing policies for multiple files at once.
Input parameters
List of files to query. Each can be a file ID (e.g., 'id:7bh4zBmgZoAAAAAAAAAAFg') or a path (e.g., '/path/to/file.txt'). Maximum 100 files per request.
A list of FileActions corresponding to FilePermissions that should appear in the response's permissions field describing the actions the authenticated user can perform on the files.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_FILE_PREVIEWTool to get a preview for a file. PDF previews are generated for document formats (.ai, .doc, .docx, .eps, .ppt, .pptx, etc.), and HTML previews are generated for spreadsheet formats (.csv, .xls, .xlsx, etc.). Use when you need to view file content without downloading the original file. Returns error for unsupported file types.
Input parameters
The path of the file to preview. Supported preview formats: PDF previews (.ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf); HTML previews (.csv, .ods, .xls, .xlsm, .gsheet, .xlsx).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_FILE_REQUESTTool to retrieve details of an existing file request by ID. Use when you need to check the status, URL, deadline, or other details of a specific file request.
Input parameters
The ID of the file request to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_FILE_TAGSTool to get list of tags assigned to files or folders in Dropbox. Use when you need to retrieve tags for one or more items. This endpoint does not support apps with the app folder permission.
Input parameters
List of file or folder paths to get tags for (e.g., \["/Documents/report.pdf", "/Photos/image.jpg"\]). Maximum of 1000 paths per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_FOLDER_CURSORTool to get a cursor representing the current state of a folder without listing its contents. Use when you only need to track future changes to a folder, not retrieve existing files. This is more efficient than list_folder for setting up change monitoring or sync functionality.
Input parameters
The path to the folder. Use "" (empty string) for the root folder, or a path like "/folder/subfolder". Also accepts folder IDs (e.g., "id:abc123xyz").
The maximum number of results to return per request when using this cursor with list_folder/continue. If not specified, the API uses a default.
If true, the cursor will include all subfolders and their contents recursively. If false, only the immediate contents are tracked.
Shared link information for listing folder contents.
If true, deleted files and folders will be included when using this cursor to track changes.
If true, media metadata (dimensions, location, etc.) will be included for photo and video files when using this cursor.
If true, results will include entries under mounted folders (app folders, shared folders, team folders).
Template filter for property groups.
If true, results will include a flag indicating whether each file or folder has explicit shared members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_JWKSTool to retrieve JSON Web Key Set containing public verification keys for Dropbox signed ID tokens. Use when you need to verify JWT signatures from Dropbox OpenID Connect authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_METADATATool to fetch metadata for a file or folder by path. Use when you need to verify existence, get canonical identifiers (id, path_display), determine type (.tag), or retrieve detailed attributes without enumerating folder contents.
Input parameters
The path of a file or folder on Dropbox (e.g., "/Documents/report.pdf"). Note: The root folder ("" or "/") is not supported by this endpoint.
If true, DeletedMetadata will be returned for deleted files or folders. Otherwise, deleted items will return an error.
If true, FileMetadata.media_info is set for photo and video files, providing additional metadata like dimensions and location.
If true, the result will include a flag indicating whether the file has any explicit shared members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_METADATA_ALPHATool to fetch metadata for a file or folder using the alpha endpoint. Use when you need metadata with advanced property filtering or custom property template support.
Input parameters
The path of a file or folder on Dropbox (e.g., "/Documents/report.pdf"). Use "" or "/" for the root folder.
If true, DeletedMetadata will be returned for deleted files or folders. Otherwise, deleted items will return an error.
If true, FileMetadata.media_info is set for photo and video files, providing additional metadata like dimensions and location.
Filter for property template IDs.
If true, the result will include a flag indicating whether the file has any explicit shared members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_OPENID_CONFIGTool to retrieve Dropbox's OpenID Connect discovery document describing supported OAuth 2.0 and OIDC parameters. Use when you need to discover Dropbox's OAuth configuration endpoints and capabilities.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_SHARED_FILE_METADATATool to retrieve metadata for a shared file in Dropbox. Use when you need to get information about a shared file's permissions, access levels, owner, and sharing policies.
Input parameters
The file to query. Can be a file ID (e.g., 'id:7bh4zBmgZoAAAAAAAAAAFg') or a path.
A list of FileActions corresponding to FilePermissions that should appear in the response's permissions field describing the actions the authenticated user can perform on the file.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_SHARED_FOLDER_METADATATool to retrieve metadata for a specific shared folder by its ID. Use when you need detailed information about a shared folder including access level, policies, owner, paths, and permissions.
Input parameters
A list of FolderActions corresponding to FolderPermissions that should appear in the response's permissions field describing the actions the authenticated user can perform on the folder
The ID for the shared folder
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_SHARED_LINK_FILETool to download a file from a Dropbox shared link. Use when you have a shared link URL and need to retrieve the actual file content. This endpoint works with shared links to files; for shared links to folders, use the path parameter to specify which file within the folder to download.
Input parameters
URL of the shared link to download the file from.
If the shared link is to a folder, this parameter can be used to retrieve a specific file or sub-folder in this folder. Path must start with '/'.
If the shared link has a password, this parameter can be used to provide it.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_SHARED_LINK_METADATATool to resolve a Dropbox shared link URL into structured metadata. Use when the user provides a shared link and you need to determine what it points to (file vs folder) and obtain canonical identifiers (id, path) to enable follow-on operations.
Input parameters
The shared link URL to retrieve metadata for.
If the shared link is to a folder, this parameter can be used to retrieve metadata for a specific file or sub-folder in this folder. A relative path should be used.
If the shared link has a password, this parameter can be used to provide it.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_SPACE_USAGETool to get space usage information for the current user's Dropbox account. Use when you need to check storage usage, available space, or quota information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_FEATURE_VALUESTool to get values for one or more team features. Use when you need to check team capabilities like upload rate limits, shared team root availability, file events, or selective sync status.
Input parameters
A list of features to get values for. At least one feature must be included. Available features: 'upload_api_rate_limit', 'has_team_shared_dropbox', 'has_team_file_events', 'has_team_selective_sync'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_FOLDER_INFOTool to retrieve metadata for team folders. Returns information about folder status, sync settings, and properties for the specified team folder IDs. Use when you need to check the status or configuration of one or more team folders.
Input parameters
The list of team folder IDs to retrieve metadata for. Must contain at least one ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_GROUPS_INFOTool to retrieve information about one or more team groups by their IDs or external IDs. Use when you need to get details about specific groups including name, member count, management type, and creation time.
Input parameters
List of Dropbox group IDs. Required when selector_type is 'group_ids'. Example: \['g:e18cdeb8c1e9c0280000000000000053', 'g:e18cdeb8c1e9c0280000000000000054'\]
The type of selector to use for identifying groups. 'group_ids' - Select groups by Dropbox group IDs. 'group_external_ids' - Select groups by external IDs.
List of external group IDs. Required when selector_type is 'group_external_ids'. These are IDs from an external system that have been associated with Dropbox groups.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_GROUPS_JOB_STATUSTool to check the status of an asynchronous team groups job in Dropbox. Use when you have an async_job_id from a previous team groups operation (like groups_delete) and need to poll its completion status.
Input parameters
Id of the asynchronous job. This is the value of a response returned from the method that launched the job (e.g., from team_groups_delete).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_INFOTool to retrieve information about a Dropbox team. Use when you need to get team details such as team name, ID, licensed user counts, or team policies.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_LOG_EVENTSTool to retrieve team audit log events from Dropbox. Use when you need to access team activity logs, audit trails, or monitor team events. Supports filtering by time range and event category, with pagination for large result sets.
Input parameters
Time range filter for events.
Maximum number of events to return per request. Default is 1000, maximum is 1000.
Cursor for pagination, obtained from a previous response. Use this to retrieve the next page of results.
Event category filter to limit results (e.g., 'apps', 'devices', 'domains', 'file_operations', 'file_requests', 'groups', 'logins', 'members', 'paper', 'passwords', 'sharing', 'team_folders', 'team_policies').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_LOG_EVENTS_CONTINUETool to paginate through team audit log events using a cursor from team_log/get_events. Use when you have a cursor from a previous call and need to retrieve the next batch of team events.
Input parameters
The cursor returned by a previous call to team_log/get_events or team_log/get_events/continue. This cursor is used to paginate through all team events.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_MEMBER_CUSTOM_QUOTATool to retrieve custom storage quotas for team members. Use when you need to check which team members have custom quota allocations and their quota amounts. Requires team admin credentials.
Input parameters
List of team member identifiers to retrieve custom quota for. Each member must be identified by exactly one of: team_member_id, external_id, or email. Maximum of 1000 users per request. An empty list returns all users with custom quotas.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_MEMBERS_ADD_JOB_STATUSTool to poll the status of an asynchronous team member addition job. Use when you have an async_job_id from team/members/add_v2 and need to check if the member addition has completed. Returns 'in_progress', 'complete' with per-member results, or 'failed' with error details.
Input parameters
Id of the asynchronous job returned from team/members/add_v2. This is used to poll the status of the asynchronous request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_MEMBERS_INFOTool to retrieve information about multiple team members in a single request. Use when you need to get details like email, name, status, role, and account information for one or more team members. Requires team admin credentials.
Input parameters
List of team member identifiers to retrieve information for. Each member must be identified by exactly one of: team_member_id, external_id, or email.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEAM_PROPERTIES_TEMPLATETool to get the schema for a specified property template for a team. Use when you need to retrieve the structure and field definitions of a team property template.
Input parameters
An identifier for a template added by route templates/add_for_user or templates/add_for_team. Typically in the format 'ptid:XXXXX'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEMPORARY_LINKTool to get a one-click temporary (expiring) download link. Use when you need to share a Dropbox file directly without proxying content through this service. Only works for files, not folders. Returned URLs expire within hours and must be regenerated for future use; never treat them as permanent links. Requires `files.content.read` scope.
Input parameters
The path or identifier of the file to get a temporary link for. Supports Dropbox path (e.g., '/folder/file.txt'), id:..., rev:..., or ns:... notation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_TEMPORARY_UPLOAD_LINKTool to get a one-time use temporary upload link to upload a file to Dropbox. Use when you need to perform a delayed upload where the file will be uploaded to the returned link via POST with Content-Type: application/octet-stream. The upload link is valid for up to 4 hours.
Input parameters
Link validity period in seconds. Maximum is 4 hours (14400 seconds).
Upload configuration specifying destination path and upload behavior.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_THUMBNAILTool to get a thumbnail for an image file. Use when you need to generate a thumbnail preview of an image. Supports jpg, jpeg, png, tiff, tif, gif, webp, ppm, and bmp files under 20MB.
Input parameters
How to resize and crop the image. 'strict': scale down to fit within the given size. 'bestfit': scale down to fit within size or its transpose. 'fitone_bestfit': scale down to completely cover size or its transpose.
The path to the image file you want to thumbnail. Must start with '/'.
The size for the thumbnail image. Options range from 32x32 pixels to 2048x1536 pixels.
The format for the thumbnail image. Use 'jpeg' for photos (default), 'png' for screenshots and digital arts.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_THUMBNAIL_BATCHTool to get thumbnails for multiple image files in a single batch request. Use when you need to generate thumbnail previews for up to 25 images at once. Supports jpg, jpeg, png, tiff, tif, gif, webp, ppm, and bmp files under 20MB.
Input parameters
List of files to get thumbnails for. Maximum 25 entries per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_THUMBNAIL_V2Tool to get a thumbnail for an image file. Use when you need to generate a thumbnail preview of an image. Supports jpg, jpeg, png, tiff, tif, gif, webp, ppm, and bmp files under 20MB. Can access files via direct path or shared link.
Input parameters
The shared link URL (required when resource_type is 'link').
How to resize and crop the image. 'strict': scale down to fit within the given size. 'bestfit': scale down to fit within size or its transpose. 'fitone_bestfit': scale down to completely cover size or its transpose.
The path to the image file (required when resource_type is 'path'). Must start with '/'.
The size for the thumbnail image. Options range from 32x32 pixels to 2048x1536 pixels.
The format for the thumbnail image. Use 'jpeg' for photos, 'png' for screenshots and digital arts.
Optional relative path within shared folder (only used with resource_type='link' when link points to a folder).
Type of resource: 'path' for direct file path or 'link' for shared link.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_GET_USER_FEATURESTool to get a list of feature values configured for the current Dropbox account. Use when you need to check which features are enabled, such as paper_as_files or file_locking.
Input parameters
A list of features to get values for. Available features: 'paper_as_files' (information about how Paper files are stored), 'file_locking' (whether users can lock files in shared directories).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_EXCLUDED_USERS_CONTINUETool to paginate through team members excluded from space limits using a cursor from a previous list call. Use when you have a cursor from the initial excluded users list endpoint and need to retrieve the next batch of excluded team members.
Input parameters
The cursor returned by a previous call to list member space limits excluded users. This cursor is used to paginate through all excluded users. Must come from a previous call to /2/team/member_space_limits/excluded_users/list or /2/team/member_space_limits/excluded_users/list/continue.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FILE_MEMBERSTool to obtain the members who have been invited to a file, both inherited and uninherited members. Use when you need to retrieve detailed information about users, groups, and invitees with access to a specific file, including their access levels and permissions.
Input parameters
The file for which you want to see members. Can be a file ID (starting with 'id:') or a file path (starting with '/').
Number of members to return max per query. Must be between 1 and 300.
The actions for which to return permissions on a member. Valid values: 'leave_a_copy', 'make_editor', 'make_owner', 'make_viewer', 'make_viewer_no_comment', 'remove'.
Whether to include members who only have access from a parent shared folder. Defaults to true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FILE_MEMBERS_BATCHTool to get members of multiple files at once. Use when you need to retrieve sharing information for multiple files in a single request. Returns users, groups, and invitees with access to each file, but does not include inherited members or detailed permissions. For more detailed results, use the individual file member endpoint.
Input parameters
Files for which to return members. Can be file IDs (starting with 'id:') or paths (starting with '/'). Maximum 100 files per request.
Number of members to return max per query per file. Defaults to 10 if not specified. Maximum 20.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FILE_REQUESTSTool to list all file requests owned by the current user. Use when you need to see existing file requests, their status, and details.
Input parameters
Maximum number of file requests to return. Default: 1000.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FILE_REQUESTS_CONTINUETool to paginate through file requests using a cursor from a previous list call. Use when you have a cursor from /2/file_requests/list or /2/file_requests/list/continue and need to retrieve the next batch of file requests.
Input parameters
The cursor returned by a previous call to list file requests. This cursor is used to paginate through all file requests. Must come from a previous call to /2/file_requests/list or /2/file_requests/list/continue.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FILE_REVISIONSTool to retrieve the revision history for a file. Use when you need to see past versions of a file, restore a previous version, or track changes over time.
Input parameters
Mode for listing revisions.
The path to the file you want to see the revisions of (e.g., "/Documents/report.pdf"). Must be a valid file path in Dropbox.
The maximum number of revision entries returned. Default is 10, minimum is 1, maximum is 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FILES_IN_FOLDERTool to list files and folders in a specified Dropbox directory. Use when you need to see the contents of a folder, including subfolders if recursive is true. When the response contains `has_more=true`, continue fetching with the returned cursor until `has_more=false` — stopping early misses entries in large folders. Response entries include both files and folders; use the `.tag` field on each entry to distinguish item types.
Input parameters
The folder path (e.g., "/europe/invoices") or folder ID (e.g., "id:aBcDeFgH123") to list contents from. Use "" (empty string) for the root folder. No trailing slashes or whitespace allowed — malformed paths can silently produce empty results. Prefer paths from `path_display` or `path_lower` fields in prior API responses over manually constructed paths.
The maximum number of results to return per request. Default is 2000. Max is 2000.
If true, recursively lists contents of nested subfolders; otherwise, lists only immediate contents. Large or broad folder trees with recursive=true can produce very large responses and high latency; use only when full hierarchy is explicitly needed.
If true, includes deleted (but potentially recoverable) files and folders in the listing.
If true, includes media metadata (e.g., dimensions, location) for photo and video files.
If true, includes non-downloadable files (e.g., Google Docs, Dropbox Paper) in the listing.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FOLDER_CONTINUETool to continue paginating through folder contents using a cursor from list_folder. Use when has_more is true to retrieve remaining entries.
Input parameters
The cursor returned by your last call to list_folder or list_folder/continue. Use this to paginate through all files and retrieve updates to the folder.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FOLDER_MEMBERSTool to list members of a shared folder, including users, groups, and invitees. Use when you need to retrieve information about who has access to a specific shared folder and their permission levels.
Input parameters
The maximum number of results that include members, groups and invitees to return per request
List indicating whether each returned member will include a boolean value showing if the current user can perform the MemberAction on the member. Valid values: 'leave_a_copy', 'make_editor', 'make_owner', 'make_viewer', 'make_viewer_no_comment', 'remove'
The ID for the shared folder
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FOLDER_MEMBERS_CONTINUETool to continue paginating through shared folder members using a cursor from list_folder_members. Use when cursor is present in list_folder_members response to retrieve remaining member entries.
Input parameters
The cursor returned by your last call to list_folder_members or list_folder_members/continue. Use this to paginate through all shared folder members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FOLDERSDEPRECATED: Use ListFilesInFolder instead. Retrieves a list of folders, files, and deleted entries from a specified Dropbox path.
Input parameters
Path to the folder (e.g., "" for root, "/folder/subfolder", or "id:abc123xyz"). If a path string, it must start with / and not end with / or whitespace.
Maximum number of folder entries to return per request; an approximate upper bound.
Whether to include folders in nested subfolders (True) or only immediate subfolders (False) Combining with a high `limit` or broad `path` can yield very large responses; scope `path` narrowly to keep result sets manageable.
Whether to include folders that have been deleted but may be recoverable
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_FOLDERS_CONTINUETool to continue paginating through shared folders using a cursor from list_folders. Use when the cursor is present in list_folders response to retrieve remaining shared folder entries.
Input parameters
The cursor returned by the previous call to list_folders or list_folders/continue. Use this to paginate through all shared folders.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_MEMBER_LINKED_APPSTool to list all applications linked to a specific team member's account. Use when you need to audit or review which third-party applications have been authorized by a particular team member.
Input parameters
The team member ID. Can be obtained from team/members/list endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_MEMBER_SPACE_LIMITS_EXCLUDED_USERSTool to list team members excluded from space limits. Use when you need to view which users are exempt from storage quotas. This is a team-level operation requiring team admin authentication.
Input parameters
Number of results to return per call. If not specified, all excluded users will be returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_MOUNTABLE_FOLDERSTool to list all shared folders the current user can mount or unmount. Use when discovering mountable shared folders (unmounted folders can be identified by absence of path_lower field). This endpoint does not support apps with the app folder permission.
Input parameters
Maximum number of mountable folders to return per request. If not specified, the API will use its default limit.
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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_MOUNTABLE_FOLDERS_CONTINUETool to paginate through mountable shared folders using a cursor. Use when you have a cursor from a previous call to list_mountable_folders or list_mountable_folders/continue and need to retrieve the next batch of folders.
Input parameters
The cursor returned by a previous call to list_mountable_folders or list_mountable_folders/continue. Use this to paginate through all mountable shared folders.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_PAPER_DOCSTool to return the list of all Paper docs according to filter and sort specifications. Use when you need to retrieve Paper document IDs for further operations. To iterate through full pagination, pass the cursor to docs/list/continue.
Input parameters
Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
Allows user to specify how the Paper docs should be sorted. 'accessed' sorts by last accessed time, 'modified' sorts by last modified time, 'created' sorts by creation time.
Allows user to specify how the Paper docs should be filtered. 'docs_accessed' fetches all Paper doc IDs that the user has ever accessed. 'docs_created' fetches only the Paper doc IDs that the user has created.
Allows user to specify the sort order of the result. 'ascending' sorts in ascending order, 'descending' sorts in descending order.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_PAPER_DOCS_CONTINUETool to continue paginating through Paper documents using a cursor from paper/docs/list. Use when has_more is true to retrieve remaining Paper documents. Note: This endpoint continues to work for older Paper content; check user features to determine Paper version.
Input parameters
The cursor obtained from paper/docs/list or paper/docs/list/continue. Allows for pagination through all Paper documents.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_RECEIVED_FILESTool to list all files shared with the current user. Returns files directly shared with the user but does not include files received via shared folders or unclaimed invitations. Use when discovering files that have been shared with the authenticated user.
Input parameters
Number of files to return max per query. Defaults to 100 if no limit is specified. Must be between 1 and 300.
A list of FileActions corresponding to FilePermissions that should appear in the response's SharedFileMetadata.permissions field describing the actions the authenticated user can perform on the file.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_SHARED_FOLDERSTool to list all shared folders the authenticated user has access to. Use when discovering shared or team-mounted folders that may not appear in a standard path listing. Returns metadata including folder name, ID, access level, and paths (if mounted).
Input parameters
Maximum number of shared folders to return per request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_SHARED_LINKSTool to list existing shared links for the current user, optionally filtered by path. Use when you need to discover or reuse existing shared links to avoid creating duplicates or to check what links already exist for a file or folder. Supports pagination via cursor for large result sets.
Input parameters
The path to the file or folder to list shared links for. If omitted, returns all shared links for the current user. If provided, returns links that grant access to the specified path (including parent folder links unless direct_only is true). Supports Dropbox path notation (e.g., '/folder/file.txt').
The cursor returned by a previous call to this endpoint. Use this to retrieve additional results when 'has_more' is true. The API returns a maximum of ~200 links per call.
If true, only return direct links to the specified path. If false or omitted, also include links to parent folders. Only relevant when 'path' is specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_SHARING_ALLOWLISTTool to list Approve List entries for a team from newest to oldest. Use when you need to retrieve allowed domains and emails for team sharing.
Input parameters
The number of entries to fetch at one time. Maximum and default is 1000.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_DEVICESTool to list all device sessions of a team including web sessions, desktop clients, and mobile clients. Use when you need to audit team devices, view active sessions, or monitor device activity across the team. Supports pagination via cursor for large result sets. Requires team admin credentials.
Input parameters
Pagination cursor for retrieving additional results. At the first call to list_team_devices, the cursor shouldn't be passed. Then, if the result includes a cursor, subsequent requests should include the received cursor to retrieve the next sub-list of team devices.
Whether to list web sessions of the team members. If omitted, defaults to the API's default behavior.
Whether to list mobile clients of the team members. If omitted, defaults to the API's default behavior.
Whether to list desktop clients of the team members. If omitted, defaults to the API's default behavior.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_FOLDERSTool to list all team folders for a Dropbox Business team. Use when you need to discover team-wide folders or manage team folder access.
Input parameters
Maximum number of team folders to return per request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_FOLDERS_CONTINUETool to continue paginating through team folders using a cursor from team_folder/list. Use when the cursor is present in list_team_folders response to retrieve remaining team folder entries.
Input parameters
The cursor returned by the previous call to team_folder/list or team_folder/list/continue. Use this to paginate through all team folders.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_GROUP_MEMBERSTool to list members of a Dropbox team group. Use when you need to retrieve the list of team members who belong to a specific group. Returns member profiles with email, status, and access information.
Input parameters
Maximum number of members to return per request. Must be between 1 and 1000.
The Dropbox group ID. Required when selector_type is 'group_id'. Example: 'g:e18cdeb8c1e9c0280000000000000003'
The type of selector to use for identifying the group. 'group_id' - Select group by Dropbox group ID. 'group_external_id' - Select group by external ID.
The external ID of the group. Required when selector_type is 'group_external_id'. This is the ID from an external system that has been associated with the Dropbox group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_GROUPSTool to list all groups on a Dropbox team. Use when you need to see all team groups with their metadata including group ID, name, and member count.
Input parameters
Number of groups to return per call. If not specified, all groups are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_GROUPS_CONTINUETool to continue listing team groups using a cursor from team/groups/list. Use when you have a cursor from a previous team groups list call and need to retrieve the next batch of groups.
Input parameters
The cursor returned by team/groups/list. Indicates from what point to get the next set of groups.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_GROUPS_MEMBERS_CONTINUETool to continue listing team group members using a cursor from team/groups/members/list. Use when you have a cursor from a previous group members list call and need to retrieve the next batch of members.
Input parameters
The cursor returned by team/groups/members/list. Indicates from what point to get the next set of group members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_LINKED_APPSTool to list all applications linked to team members' accounts. Use when you need to audit or review which third-party applications have been authorized by team members. Supports pagination for large teams.
Input parameters
At the first call, the cursor shouldn't be passed. Then, if the result includes a cursor, subsequent requests should include the received cursor to receive the next sub-list of team applications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_MEMBER_DEVICESTool to list all device sessions of a team's member, including web sessions, desktop clients, and mobile clients. Use when you need to retrieve information about a team member's active devices and sessions.
Input parameters
The team's member id. Can be obtained from team/members/list endpoint.
Whether to list web sessions of the team's member. Defaults to true.
Whether to list linked mobile devices of the team's member. Defaults to true.
Whether to list linked desktop devices of the team's member. Defaults to true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_MEMBERSTool to list members of a Dropbox team. Use when you need to retrieve information about team members, including their status, roles, and contact details. Supports pagination for teams with many members.
Input parameters
Number of results to return per call. Maximum is 1000. If not specified, the server will use a default value.
Whether to return members who have been removed from the team. If true, includes removed members in the results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_MEMBERS_CONTINUETool to continue listing team members using a cursor from team/members/list or team/members/list/continue_v2. Use when you have a cursor from a previous team members list call and need to retrieve the next batch of members.
Input parameters
The cursor returned by team/members/list or team/members/list/continue_v2. Indicates from what point to get the next set of members.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_NAMESPACESTool to list all team-accessible namespaces in a Dropbox Business team. Use when you need to discover team folders, shared folders, member home namespaces, or app folders accessible to the team.
Input parameters
Specifying a value here has no effect. The parameter is included for API compatibility but is not functional.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_NAMESPACES_CONTINUETool to continue paginating through team-accessible namespaces using a cursor from team/namespaces/list. Use when you have a cursor and need to retrieve the next batch of team namespaces.
Input parameters
Cursor returned by a previous call to team/namespaces/list or team/namespaces/list/continue. Use this to paginate through all team-accessible namespaces.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEAM_SHARING_ALLOWLIST_CONTINUETool to continue paginating through team sharing allowlist entries using a cursor. Use when you have a cursor from a previous sharing_allowlist/list or sharing_allowlist/list/continue call and need to retrieve the next batch of allowed domains and emails.
Input parameters
The cursor returned by a previous call to sharing_allowlist/list or sharing_allowlist/list/continue. Use this to paginate through all allowlist entries.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_TEMPLATES_FOR_TEAMTool to list all property templates for a team. Use when you need to retrieve available custom file property templates at the team level. Requires a Dropbox Business account with team-level authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_LIST_USER_TEMPLATESTool to get the template identifiers for a user. Use when you need to retrieve available custom file property templates that can be applied to files.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_MODIFY_SHARED_LINK_SETTINGSTool to modify settings of an existing Dropbox shared link. Use when the user needs to change visibility, access permissions, expiration, or password settings for a shared link. Supports changing audience (public/team/private), access level (viewer/editor), expiration dates, and password protection.
Input parameters
The URL of the shared link to modify. This must be a valid Dropbox shared link URL.
The new settings to apply to the shared link. Only the specified fields will be updated; unspecified fields remain unchanged.
If set to true, removes the expiration date from the shared link. This overrides any 'expires' value in settings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_MOUNT_FOLDERTool to mount a shared folder for the current user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox. Use when a user needs to access a shared folder that has been shared with them but not yet mounted.
Input parameters
The ID of the shared folder to mount.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_MOVE_BATCHTool to move multiple files or folders to different locations at once in Dropbox. Use when you need to relocate several items in a single operation. Note that case-only renaming is not supported. The operation may complete synchronously (returning status for each entry) or asynchronously (returning a job ID to check later with move_batch/check:2).
Input parameters
List of entries to be moved. Each entry specifies a from_path and to_path. Minimum 1 entry, maximum 1000 entries.
If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict. The default is false.
Allow moves by owner even if it would result in an ownership transfer for the content being moved. The default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_MOVE_FILE_OR_FOLDERMove file or folder
Input parameters
Path in the user's Dropbox that is the destination. This path is case-sensitive.
Path in the user's Dropbox to be moved. This path is case-sensitive. Use canonical paths from metadata (path_display or path_lower) rather than manually constructed strings to avoid path/not_found errors.
If there's a conflict (e.g., a file with the same name already exists at the destination), have the Dropbox server try to auto-rename the file to avoid the conflict. The default is false. Leaving this false will cause the call to fail outright when a name conflict exists at the destination.
If true, allows moving shared folders. The default is false.
Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies. The default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_OVERWRITE_FILE_PROPERTIESTool to overwrite property groups associated with a file or folder. Use when you need to force apply or replace custom property values for specific templates on a file.
Input parameters
A unique identifier for the file or folder. Can be a path (e.g., '/test_file.txt') or a file ID.
The property groups to force apply. This operation will overwrite existing property groups for the specified templates.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_READ_FILEDownloads a file from the specified Dropbox path, requiring `files.content.read` scope. Response field `file_content_bytes` is base64-encoded binary; decode before saving or passing to libraries. Bursty reads may trigger HTTP 429; honor the `Retry-After` header.
Input parameters
The path to search in Must be a canonical Dropbox path from `path_display` or `path_lower` in API results — hand-typed paths frequently cause not-found or 409 errors. Paths in shared/team folders may become invalid if items are moved or access is revoked.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_FILE_MEMBERTool to remove a specified member from a file's sharing permissions. Use when you need to revoke a member's access to a shared file. Note: This does not support apps with the app folder permission.
Input parameters
File from which to remove members. Use the file ID in the format 'id:...' or the file path.
Member to remove from this file. Specify either by email or dropbox_id.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_FILE_PROPERTIESTool to permanently remove specified property groups from a file or folder. Use when you need to delete custom properties associated with a file.
Input parameters
A unique identifier for the file or folder. This can be a path (e.g., '/test_properties_file.txt') or a file ID.
A list of identifiers for property templates to remove from the file. These are template IDs created by templates/add_for_user or templates/add_for_team. Use an empty list to remove all property groups.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_FILE_PROPERTIES_TEMPLATE_FOR_TEAMTool to remove a property template from a team. Use when you need to delete a file properties template that was previously added to the team.
Input parameters
An identifier for a template created by templates/add_for_user or templates/add_for_team. Format: ptid:XXXX
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_FILE_TAGTool to remove a tag from a file or folder in Dropbox. Use when you need to delete or untag an existing tag from an item. The tag will be removed only if it exists on the specified path.
Input parameters
Path to the file or folder to remove the tag from. Must start with a slash.
The tag to remove. Will be automatically converted to lowercase letters by Dropbox.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_FOLDER_MEMBERTool to remove a member from a shared folder. Use when an owner or editor needs to revoke access for a user or group. The member can be identified by email or Dropbox ID. On success, the response is empty; on error, contains detailed error information.
Input parameters
The member to remove from the shared folder. Can be identified by email address or Dropbox ID
If true, the removed user will keep their copy of the folder after it's unshared (if mounted). Otherwise, it will be removed from their Dropbox. Must be false when kicking a group
The ID for the shared folder from which to remove the member
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_GROUP_MEMBERSTool to remove members from a Dropbox team group. Use when you need to remove one or more users from a team group. Requires team admin permissions.
Input parameters
The group from which users will be removed. Specify either by group_id or group_external_id
List of users to be removed from the group. Each user can be identified by team_member_id, external_id, or email
Whether to return the list of members in the group after removal. Note that setting this to true may take a long time for large groups. Default is false
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_SHARING_ALLOWLISTTool to remove domains or email addresses from the team sharing allowlist. Use when team admins need to revoke approval for specific domains or emails. Requires team admin authentication. At least one of 'domains' or 'emails' must be provided, with a maximum of 1000 entries per call. Entries must already exist on the allowlist.
Input parameters
List of email addresses to remove from the allowlist. Each email must be a valid string representation following RFC-5322/822 (e.g., 'user@example.com'). Entries must already exist on the allowlist. Maximum 1000 entries per call. At least one of 'domains' or 'emails' must be provided
List of domains to remove from the allowlist. Each domain must be a valid string representation following RFC-1034/5 (e.g., 'example.com', 'subdomain.example.org'). Entries must already exist on the allowlist. Maximum 1000 entries per call. At least one of 'domains' or 'emails' must be provided
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_TEAM_MEMBER_CUSTOM_QUOTATool to remove custom storage quota for team members, reverting them to the team's default quota. Use when you need to reset storage limits for specific team members. Requires team admin credentials.
Input parameters
List of users to remove custom quota from. Each user must be identified by exactly one of: team_member_id, external_id, or email. Maximum of 1000 users per request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REMOVE_TEAM_MEMBER_SPACE_LIMITS_EXCLUDED_USERSTool to remove users from the member space limits excluded users list. Use when you need to re-enable space limits for specific team members. Maximum of 1000 users per request. Requires team admin credentials.
Input parameters
List of users to be removed from the excluded users list. Maximum of 1000 users per request
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_RENAME_TEAM_FOLDERTool to rename an existing team folder in Dropbox. Use when you need to update the name of a team folder.
Input parameters
New name for the team folder.
The ID of the team folder to rename. You can get this from list team folders action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_RESEND_SECONDARY_EMAIL_VERIFICATIONTool to resend secondary email verification emails to team members. Use when team members need verification emails resent for their secondary email addresses. Requires team admin credentials.
Input parameters
Collection of users paired with secondary emails needing verification resent. Each item contains the user identifier and list of secondary email addresses
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_RESTORE_FILETool to restore a specific revision of a file to the given path in Dropbox. Use when you need to revert a file to a previous version using its revision identifier.
Input parameters
The revision to restore for the file. This is a unique identifier for a specific version of the file.
The path to the file you want to restore in the user's Dropbox. Path is case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_REVOKE_SHARED_LINKTool to revoke a Dropbox shared link. Use when you need to remove access to a file or folder by disabling its shared link. Note that revoking a direct link to a file may not fully prevent access if parent folders have active shared links.
Input parameters
The URL of the shared link to revoke. Can be any valid Dropbox shared link URL. Note: After revoking a link, the file may still be accessible if there are shared links to parent folders.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SAVE_COPY_REFERENCETool to save a copy reference to the user's Dropbox. Use when you have a copy reference (obtained from copy_reference/get) and need to save it to a specific destination path.
Input parameters
Path in the user's Dropbox that is the destination where the referenced file or folder will be saved. This path is case-sensitive and must start with '/'.
A copy reference returned by copy_reference/get. This is an opaque string that can be used to save a file or folder to the user's Dropbox.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SAVE_URLTool to save a file to Dropbox directly from a public URL via server-side fetch. Use when you have a temporary or public link and want Dropbox to download it directly without local staging. The operation is asynchronous and may take up to 15 minutes for large files.
Input parameters
The URL to be saved. Must be a valid, publicly accessible URL.
The path in Dropbox where the URL will be saved to (including filename). Must start with a slash.
If true, poll the job status until completion or timeout. If false, return the async_job_id immediately.
Maximum time in seconds to wait for job completion when wait=true. Ignored if wait=false.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SEARCH_CONTINUETool to fetch the next page of search results from a previous Dropbox search. Use when you have a cursor from a search operation and need to retrieve additional results. Note: search along with search_continue can only retrieve a maximum of 10,000 matches total.
Input parameters
The cursor returned by your last call to search or search_continue. Used to fetch the next page of results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SEARCH_FILE_OR_FOLDERTool to search for files and folders in Dropbox by name or content, optionally scoped to a path, with pagination support. Results paginate via cursor (up to 100 per page); check `has_more` in the response and re-fetch with the cursor until `has_more` is false. Newly indexed items may have a brief delay before appearing. Verify `path_display` and `.tag` (file vs folder) on each result before acting, as multiple similar-named items may match. Results are limited to items visible to the authenticated user.
Input parameters
The search string. Must be 1 or more non-whitespace characters. Queries are case-insensitive. Required unless cursor is provided.
Cursor from a previous search response for fetching the next page of results. When provided, all other parameters are ignored and the continue endpoint is called.
Additional options for the search. If not provided, default search options will be used. Key sub-fields: `path` (must start with '/' or use 'id:...' format; omit to search entire account, narrow to reduce noise); `file_categories` and `file_extensions` to filter by type; no native date-range filter — apply date logic client-side using `server_modified` (UTC). Prefer reusing `path_display` values from prior results rather than manually composing paths.
Options for match field highlighting. If not provided, default options will be used.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SEARCH_FILE_PROPERTIESTool to search across property templates for particular property field values. Use when you need to find files or folders that have specific custom property values (e.g., find all files with priority='high'). Note: This endpoint does not support apps with the app folder permission.
Input parameters
List of queries to search. Each query specifies a property field value to search for and the field name to search within.
Filter results to contain only properties associated with specific template IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SEND_TEAM_MEMBER_WELCOME_EMAILTool to send a welcome email to a pending team member. Use when a team admin needs to resend or send a welcome email to a user who has been invited to the team.
Input parameters
Type of identifier to use: 'team_member_id' for team member ID, 'external_id' for external ID, or 'email' for email address
Email address of the user. Required when tag is 'email'
External ID of the user. Required when tag is 'external_id'
The team member ID of the user. Required when tag is 'team_member_id'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SET_PROFILE_PHOTOTool to set the profile photo for the current user's Dropbox account. Use when you need to update or change the user's profile picture. Requires a base64-encoded JPEG image.
Input parameters
Photo data to set as the profile photo. Must be a base64-encoded JPEG image.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SET_TEAM_MEMBER_CUSTOM_QUOTATool to set custom storage quotas for team members in Dropbox. Use when you need to assign specific storage limits to individual team members. Maximum of 1000 users per request.
Input parameters
List of users and their custom quotas to set. Maximum of 1000 users per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_SHARE_FOLDERTool to share a folder with collaborators in Dropbox. Most sharing will be completed synchronously, but large folders will be completed asynchronously. If an async_job_id is returned, you'll need to call check_share_job_status until the action completes to get the folder metadata. Use when you need to create a shared folder or convert an existing folder to a shared folder.
Input parameters
The path to the folder to share. If it does not exist, then a new one is created. Must be a valid Dropbox path (e.g., '/TestSharedFolder').
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.
Whether to force the share to happen asynchronously. Large folders will be completed asynchronously anyway. Set to true to make testing the async case repeatable.
Settings that apply to a link.
Policy governing who can be a member of a shared folder.
Who can change a shared folder's access control list.
Who can view shared links in this folder.
Who can enable/disable viewer info for this shared folder.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_START_UPLOAD_SESSIONTool to start a new upload session with the given data. Use when uploading large files in multiple requests. This call starts the session and you can then use upload_session/append_v2 to add more data and upload_session/finish to complete the upload. A single request should not upload more than 150 MiB.
Input parameters
If true, the current session will be closed after uploading this data, at which point you won't be able to call upload_session/append_v2 anymore with the current session. Set to false to keep the session open for appending more data.
File data to upload in this initial session.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_START_UPLOAD_SESSION_BATCHTool to start a batch of upload sessions. Use when you need to upload multiple large files and want to initialize multiple upload sessions at once. Each session can then be used with upload_session/append_v2 to upload file chunks and upload_session/finish_batch to complete the uploads.
Input parameters
The number of upload sessions to start. Must be between 1 and 1000.
Type of upload session. 'sequential' means pieces of data are uploaded sequentially one after another (default). 'concurrent' means pieces of data can be uploaded in concurrent RPCs in any order.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UNLOCK_FILE_BATCHTool to unlock multiple files at specified paths in a single batch operation. Locked files can only be unlocked by the lock holder or a team admin (for business accounts). Returns metadata for each unlocked file or error details for failures.
Input parameters
List of files to unlock. Each entry contains a path or file ID. Duplicate paths are processed only once.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UNMOUNT_FOLDERTool to unmount a shared folder for the current user. Once unmounted, the shared folder will be removed from the user's Dropbox. Use when a user wants to remove a shared folder from their Dropbox while remaining a member of the folder.
Input parameters
The ID of the shared folder to unmount.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UNSHARE_FILETool to remove all members from a Dropbox file. Use when you need to revoke access for all collaborators on a file. Note: This does not remove inherited members from parent folders and does not support apps with the app folder permission.
Input parameters
The file to unshare. Use the file ID format (e.g., 'id:7bh4zBmgZoAAAAAAAAABJA') or a path to the file. This action removes all members from the file, but does not remove inherited members from parent folders.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UNSHARE_FOLDERTool to allow a shared folder owner to unshare the folder. Use when you need to stop sharing a folder with all members. Unshare will not work if: the shared folder contains shared folders OR the shared folder is inside another shared folder. You must call check_job_status with the returned async_job_id to determine if the action completed successfully. Requires sharing.write scope.
Input parameters
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. Default is false
The ID for the shared folder to unshare. You can get this from list_shared_folders action
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_FILE_MEMBERTool to change a member's access level on a shared file. Use when you need to update permissions for an existing file member (e.g., change from editor to viewer or vice versa). Note: This endpoint does not support apps with the app folder permission.
Input parameters
File for which to update the member's access. Can be a file path (e.g., '/test_read_file_basic.txt') or file ID (e.g., 'id:xxxxx').
The member whose access to update. Identify by email or Dropbox ID.
The new access level for the member. 'viewer' - The member can only view the file. 'editor' - The member can edit the file. Note: Editor access may fail with no_permission for certain file types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_FILE_PROPERTIESTool to update custom properties on a file or folder in Dropbox. Use when you need to modify metadata fields associated with a property template, such as updating status, priority, or other custom attributes. Requires the files.metadata.write scope.
Input parameters
A unique identifier for the file or folder. Can be a path (e.g., '/test.txt') or file ID (e.g., 'id:a4ayc_80_OEAAAAAAAAAXz').
The property groups 'delta' updates to apply. Each update specifies a template ID and the fields to add/update or remove.
Team member ID (format: dbmid:...) required when using team tokens. Specifies which team member's account to operate on.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_FILE_REQUESTTool to update an existing file request in Dropbox. Use when you need to modify the title, destination, deadline, open/closed status, or description of a file request.
Input parameters
The ID of the file request to update. Example: 'oaCAVmEyrqYnkZX9955Y'
Whether to set this file request as open or closed. If true, the file request will accept files. If false, it will be closed.
The new title of the file request. Must not be empty if provided.
Represents the deadline parameters when updating a file request deadline.
The new description of the file request.
The new path in the user's Dropbox where uploaded files will be saved. Must be a path starting with '/'. Example: '/Homework/math'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_FOLDER_MEMBERTool to update another member's permissions in a shared folder. Use when an owner or editor needs to change access levels for existing members. This endpoint does not support apps with the app folder permission.
Input parameters
The member of the shared folder to update. Note: Only the dropbox_id may be used for updates according to API docs, but email is also supported by the endpoint
The new access level for the member. Note: Cannot set access level to 'owner' through this endpoint
The ID of the shared folder containing the member to update. You can get this from list_shared_folders action
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_FOLDER_POLICYTool to update the sharing policies for a shared folder. Use when you need to change who can be members, who can update the ACL, viewer info settings, shared link policies, or link settings. User must have AccessLevel.owner access to the shared folder.
Input parameters
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
Settings that apply to a link.
Policy governing who can be a member of a shared folder.
The ID for the shared folder. You must have AccessLevel.owner access to update its policies
Who can change a shared folder's access control list (ACL).
Policy governing who can view shared links.
Policy governing who can view viewer information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_GROUP_MEMBER_ACCESS_TYPETool to change a member's access type in a team group. Use when you need to promote a member to owner or demote an owner to regular member. Requires team admin permissions with group management capabilities.
Input parameters
The user whose access type will be changed. Must be an existing member of the group. Can be identified by team_member_id, external_id, or email
The group containing the member whose access type will be changed. Specify either by group_id or group_external_id
The new access type to assign to the user in the group
Whether to return the list of members in the group after updating. Note that the default value will cause all group members to be returned, which may take a long time for large groups
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_PAPER_DOCUMENTTool to update an existing Dropbox Paper document with new content in Markdown, HTML, or plain text format. Use when you need to modify, append, prepend, or overwrite content in an existing Paper doc. This endpoint does not support apps with the app folder permission.
Input parameters
Path to the existing Paper doc in Dropbox to update. MUST include the .paper extension at the end (e.g., '/My Documents/Notes.paper').
Content to add or replace in the Paper document based on the update policy.
Format of the provided content: plain_text, markdown, or html.
The paper revision number. Required when doc_update_policy is 'update'. This value must match the current revision of the doc or an error will be returned.
Policy for updating the document: 'append' adds content to the end, 'prepend' adds content to the beginning, 'overwrite' replaces all content, 'update' merges content intelligently (requires paper_revision).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_PROPERTY_TEMPLATE_FOR_TEAMTool to update a property template for a team in Dropbox. Use when you need to modify an existing template's name, description, or add new property fields. Requires team admin permissions and a Dropbox Business account.
Input parameters
A display name for the template. Template names can be up to 256 bytes. If not provided, the name will not be changed.
Property field templates to be added to the group template. There can be up to 32 properties in a single template.
Description for the template. Template descriptions can be up to 1024 bytes. If not provided, the description will not be changed.
An identifier for template added by templates/add_for_user or templates/add_for_team. Typically in the format 'ptid:XXXXX'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_TEAM_FOLDER_SYNC_SETTINGSTool to update the sync settings on a team folder or its contents in Dropbox. Use when you need to control whether a team folder or specific content within it is synchronized to members' devices. This is useful for managing storage space and controlling access to sensitive content.
Input parameters
The sync setting to apply to the team folder. Possible values: 'default' (sync normally), 'not_synced' (do not sync)
The ID of the team folder to update sync settings for. You can get this from list_team_folders or other team folder operations
Optional list of content-specific sync settings within the team folder. Each entry specifies a file or folder ID and its desired sync setting
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_TEAM_GROUPTool to update a team group's name, external ID, and/or management type. Use when you need to modify group properties such as renaming a group or changing how it's managed.
Input parameters
Specify the group to update by either group_id or group_external_id.
The new name for the group. If not provided, the group name remains unchanged.
Whether to return the list of members in the response. Note that the default will cause all group members to be returned, which may take a long time for large groups.
The new external ID for the group. If not provided, the external ID remains unchanged. Set to empty string to clear the external ID.
The management type for the group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_TEAM_MEMBER_ADMIN_PERMISSIONSTool to update a team member's admin permissions. Use when you need to grant or revoke admin privileges for team members. Requires team admin permissions to execute.
Input parameters
Identity of the team member whose admin permissions will be set. Use exactly one of team_member_id, email, or external_id to identify the user
The new admin permissions role to assign to the team member
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_TEAM_MEMBER_PROFILETool to update a team member's profile information. Use when you need to change a team member's email, name, external ID, or directory restrictions. At least one profile field must be provided for update.
Input parameters
Identity of user whose profile will be set. Exactly one of team_member_id, email, or external_id must be provided to identify the user account
New email for member
New surname for member
New given name for member
New external ID for member
New persistent ID. This field only available to teams using persistent ID SAML configuration
New value for whether the user is a directory restricted user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPDATE_TEAM_MEMBER_PROFILE_PHOTOTool to update a team member's profile photo. Use when you need to set or change the profile picture of a team member. Requires team admin permissions and a JPEG image (minimum 128x128 pixels) in base64 format.
Input parameters
The team member whose profile photo should be updated.
The photo data to be set as the team member's profile photo.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
DROPBOX_UPLOAD_FILEUploads a file (up to ~150 MB) to a specified path in the user's Dropbox, with options for handling existing files. Files larger than 150 MB require a chunked upload approach.
Input parameters
Specifies how to handle the upload if a file already exists at the specified path.
If true, the user will not be notified of the new file via desktop or mobile notifications.
Path in the user's Dropbox to save the file.
File to be uploaded; supports various formats including images, PDFs, and text files. Must be a valid internal s3key obtained from a trusted upload helper — raw file bytes, public URLs, or manually constructed keys are not accepted. Ensure the content is the intended file and not an HTML/XML error page from the source server.
If true and a file already exists at the path, the new file will be renamed to avoid conflict.
If true, the upload will be rejected if the file already exists, regardless of the autorename setting.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 50 agents privately built on Nagent that already use Dropbox.
Build on Nagent
Connect Dropbox to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Dropbox, and click "Connect Now." You'll authenticate with OAuth — Nagent handles credential storage and refresh automatically. Once connected, Dropbox is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Dropbox is connected, you configure its 177 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Dropbox steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Dropbox event fires, the agent kicks off automatically.
Every Dropbox action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Dropbox ships with 177 pre-built file management & storage actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Dropbox together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Dropbox-based workflows tailored to your business.