Below commands are to retrieve information about team members.
Command | Description |
---|---|
dropbox team member list | Display comprehensive list of all team members with their status, roles, and account details |
dropbox team member feature | Display feature settings and capabilities enabled for specific team members, helping understand member permissions |
dropbox team member folder list | Display all folders in each team member’s account, useful for content auditing and storage analysis |
dropbox team member quota list | Display storage quota assignments for all team members, helping monitor and plan storage distribution |
dropbox team member quota usage | Show actual storage usage for each team member compared to their quotas, identifying storage needs |
dropbox team activity user | Retrieve activity logs for specific team members, showing their file operations, logins, and sharing activities |
Below commands are for managing team member accounts. Those commands are for a bulk operation by a CSV file.
Command | Description |
---|---|
dropbox team member batch invite | Send batch invitations to new team members, streamlining the onboarding process for multiple users |
dropbox team member batch delete | Remove multiple team members in batch, efficiently managing team departures and access revocation |
dropbox team member batch detach | Convert multiple team accounts to individual Basic accounts, preserving personal data while removing team access |
dropbox team member batch reinvite | Resend invitations to pending members who haven’t joined yet, ensuring all intended members receive access |
dropbox team member update batch email | Update email addresses for multiple team members in batch, managing email changes efficiently |
dropbox team member update batch profile | Update profile information for multiple team members including names and job titles in batch |
dropbox team member update batch visible | Make hidden team members visible in the directory, restoring standard visibility settings |
dropbox team member update batch invisible | Hide team members from the directory listing, enhancing privacy for sensitive roles or contractors |
dropbox team member quota batch update | Modify storage quotas for multiple team members in batch, managing storage allocation efficiently |
Member profile commands are for bulk updating member profile information.\nIf you need to update the members’ email addresses, use the member update email
command. The command member update email
receives a CSV file to bulk update email addresses.\nIf you need to update the member’s display name, use the member update profile
command.
Command | Description |
---|---|
dropbox team member update batch email | Update email addresses for multiple team members in batch, managing email changes efficiently |
dropbox team member update batch profile | Update profile information for multiple team members including names and job titles in batch |
You can see existing member storage quota setting or usage by the dropbox team member quota list
and dropbox team member quota usage
command. If you need to update member quota, use the dropbox team member quota update
command. The command dropbox team member quota update
receives CSV input for bulk updating storage quota setting.
Command | Description |
---|---|
dropbox team member quota list | Display storage quota assignments for all team members, helping monitor and plan storage distribution |
dropbox team member quota usage | Show actual storage usage for each team member compared to their quotas, identifying storage needs |
dropbox team member quota batch update | Modify storage quotas for multiple team members in batch, managing storage allocation efficiently |
There are two types of commands available for suspending/unsuspending members. If you wanted to suspend/unsuspend a member one by one, please use dropbox team member suspend
or dropbox team member unsuspend
. Otherwise, if you want to suspend/unsuspend members through a CSV file, please use the dropbox team member batch suspend
or dropbox member batch unsuspend
command.
Command | Description |
---|---|
dropbox team member suspend | Temporarily suspend a team member’s access to their account while preserving all data and settings |
dropbox team member unsuspend | Restore access for a suspended team member, reactivating their account and all associated permissions |
dropbox team member batch suspend | Temporarily suspend multiple team members’ access while preserving their data and settings |
dropbox team member batch unsuspend | Restore access for multiple suspended team members, reactivating their accounts in batch |
Directory restriction is the Dropbox for teams feature to hide a member from others. Below commands update this setting to hide or unhide members from others.
Command | Description |
---|---|
dropbox team member update batch visible | Make hidden team members visible in the directory, restoring standard visibility settings |
dropbox team member update batch invisible | Hide team members from the directory listing, enhancing privacy for sensitive roles or contractors |
Below commands are for managing groups.
Command | Description |
---|---|
dropbox team group add | Create a new group in your team for organizing members and managing permissions collectively |
dropbox team group batch add | Create multiple groups at once using batch processing, efficient for large-scale team organization |
dropbox team group batch delete | Remove multiple groups from your team in batch, streamlining group cleanup and reorganization |
dropbox team group delete | Remove a specific group from your team, automatically removing all member associations |
dropbox team group list | Display all groups in your team with member counts and group management types |
dropbox team group rename | Change the name of an existing group to better reflect its purpose or organizational changes |
dropbox team group update type | Change how a group is managed (user-managed vs company-managed), affecting who can modify group membership |
You can add/delete/update group members by the below commands. If you want to add/delete/update group members by CSV file, use dropbox team group member batch add
, dropbox team group member batch delete
, or dropbox team group member batch update
.
Command | Description |
---|---|
dropbox team group member add | Add individual team members to a specific group for centralized permission management |
dropbox team group member delete | Remove a specific member from a group while preserving their other group memberships |
dropbox team group member list | Display all members belonging to each group, useful for auditing group compositions and access rights |
dropbox team group member batch add | Add multiple members to groups efficiently using batch processing, ideal for large team reorganizations |
dropbox team group member batch delete | Remove multiple members from groups in batch, streamlining group membership management |
dropbox team group member batch update | Update group memberships in bulk by adding or removing members, optimizing group composition changes |
There are two commands to find unused groups. The first command is dropbox team group list
. The command dropbox team group list
will report the number of members of each group. If it’s zero, a group is not currently used to adding permission to folders.\nIf you want to see which folder uses each group, use the command dropbox team group folder list
. dropbox team group folder list
will report the group to folder mapping. The report group_with_no_folders
will show groups with no folders.\nYou can safely remove groups once you check both the number of members and folders. After confirmation, you can bulk delete groups by using the command dropbox team group batch delete
.
Command | Description |
---|---|
dropbox team group list | Display all groups in your team with member counts and group management types |
dropbox team group folder list | Display all folders accessible by each group, showing group-based content organization and permissions |
dropbox team group batch delete | Remove multiple groups from your team in batch, streamlining group cleanup and reorganization |
Admins can handle team folders, shared folders or member’s folder content through Dropbox Business API. Please be careful to use those commands. The namespace is a term in the Dropbox API that is used to manage folder permissions or settings. Folder types such as shared folders, team folders, or nested folders in a team folder, member’s root folder or member’s app folder are all managed as a namespace.\nThe namespace commands can handle all types of folders, including team folders and member’s folder. But commands for specific folder types have more features or detailed information in the report.
You can create, archive or permanently delete team folders by using the below commands. Please consider using dropbox team teamfolder batch
commands if you need to handle multiple team folders.
Command | Description |
---|---|
dropbox team teamfolder add | Create a new team folder for centralized team content storage and collaboration |
dropbox team teamfolder archive | Archive a team folder to make it read-only while preserving all content and access history |
dropbox team teamfolder batch archive | Archive multiple team folders in batch, efficiently managing folder lifecycle and compliance |
dropbox team teamfolder batch permdelete | Permanently delete multiple archived team folders in batch, freeing storage space |
dropbox team teamfolder batch replication | Replicate multiple team folders to another team account in batch for migration or backup |
dropbox team teamfolder file size | Calculate storage usage for team folders, providing detailed size analytics for capacity planning |
dropbox team teamfolder list | Display all team folders with their status, sync settings, and member access information |
dropbox team teamfolder permdelete | Permanently delete an archived team folder and all its contents, irreversibly freeing storage |
dropbox team teamfolder policy list | Display all access policies and restrictions applied to team folders for governance review |
dropbox team teamfolder sync setting list | Display sync configuration for all team folders, showing default sync behavior for members |
dropbox team teamfolder sync setting update | Modify sync settings for multiple team folders in batch, controlling automatic synchronization behavior |
You can bulk add or delete members into team folders or sub-folders of a team folder through the below commands.
Command | Description |
---|---|
dropbox team teamfolder member list | Display all members with access to each team folder, showing permission levels and access types |
dropbox team teamfolder member add | Add multiple users or groups to team folders in batch, streamlining access provisioning |
dropbox team teamfolder member delete | Remove multiple users or groups from team folders in batch, managing access revocation efficiently |
The below commands are for both team folders and shared folders of the team.\nIf you wanted to know who actually use specific folders, please consider using the command dropbox team content mount list
. Mount is a status a user add a shared folder to his/her Dropbox account.
Command | Description |
---|---|
dropbox team content member list | Display all members with access to team folders and shared folders, showing permission levels and folder relationships |
dropbox team content member size | Calculate member counts for each team folder and shared folder, helping identify heavily accessed content and optimize permissions |
dropbox team content mount list | Display mount status of all shared folders for team members, identifying which folders are actively synced to member devices |
dropbox team content policy list | Review all access policies and restrictions applied to team folders and shared folders for governance compliance |
Command | Description |
---|---|
dropbox team namespace list | Display all team namespaces including team folders and shared spaces with their configurations |
dropbox team namespace summary | Generate comprehensive summary reports of team namespace usage, member counts, and storage statistics |
dropbox team namespace file list | Display comprehensive file and folder listings within team namespaces for content inventory and analysis |
dropbox team namespace file size | Calculate storage usage for files and folders in team namespaces, providing detailed size analytics |
dropbox team namespace member list | Show all members with access to each namespace, detailing permissions and access levels |
Command | Description |
---|---|
dropbox team filerequest list | Display all active and closed file requests created by team members, helping track external file collection activities |
Command | Description |
---|---|
dropbox team member file permdelete | Permanently delete files or folders from a team member’s account, bypassing trash for immediate removal |
Team Insight is a feature of Dropbox Business that provides a view of team folder summary.
Command | Description |
---|---|
dropbox team insight scan | Perform comprehensive data scanning across your team for analytics and insights generation |
dropbox team insight scanretry | Re-run failed or incomplete scans to ensure complete data collection for team insights |
dropbox team insight summarize | Generate summary reports from scanned team data, providing actionable insights on team usage and patterns |
dropbox team insight report teamfoldermember | Generate detailed reports on team folder membership, showing access patterns and member distribution |
The team shared link commands are capable of listing all shared links in the team or update/delete specified shared links.
Command | Description |
---|---|
dropbox team sharedlink list | Display comprehensive list of all shared links created by team members with visibility and expiration details |
dropbox team sharedlink cap expiry | Apply expiration date limits to all team shared links for enhanced security and compliance |
dropbox team sharedlink cap visibility | Enforce visibility restrictions on team shared links, controlling public access levels |
dropbox team sharedlink update expiry | Modify expiration dates for existing shared links across the team to enforce security policies |
dropbox team sharedlink update password | Add or change passwords on team shared links in batch for enhanced security protection |
dropbox team sharedlink update visibility | Change access levels of existing shared links between public, team-only, and password-protected |
dropbox team sharedlink delete links | Delete multiple shared links in batch for security compliance or access control cleanup |
dropbox team sharedlink delete member | Remove all shared links created by a specific team member, useful for departing employees |
dropbox team sharedlink cap
and dropbox team sharedlink update
Commands dropbox team sharedlink update
is for setting a value to the shared links. Commands dropbox team sharedlink cap
is for putting a cap value to the shared links.\nFor example: if you set expiry by dropbox team sharedlink update expiry
with the expiration date 2021-05-06. The command will update the expiry to 2021-05-06 even if the existing link has a shorter expiration date like 2021-05-04.\nOn the other hand, dropbox team sharedlink cap expiry
updates links when the link has a longer expiration date, like 2021-05-07.\n\nSimilarly, the command dropbox team sharedlink cap visibility
will restrict visibility only when the link has less protected visibility. For example, if you want to ensure shared links without passwords are restricted to the team only. dropbox team sharedlink cap visibility
will update visibility to the team only when a link is public and has no password.
List all public links in the team\n\n\n\nResults are stored in CSV, xlsx, and JSON format. You can modify the report for updating shared links.\nIf you are familiar with the command jq, you can create CSV file directly like below.\n\n\n\nList links filtered by link owner email address:\n\n\n
Delete all link that listed in the CSV file\n\n\n\nIf you are familiar with jq command, you can send data directly from the pipe like below (pass single dash -
to the -file
option to read from standard input).\n\nInvalid argument: team sharedlink delete links -file -n
Error:
© 2016-2025 Takayuki Okazaki
Licensed under open source licenses. Use the license
command for more detail.
Tools for Dropbox and Dropbox for teams
tbx command
Command | Description | Notes | |
---|---|---|---|
asana | Asana commands | ||
config | CLI configuration | ||
deepl | DeepL commands | ||
dropbox | Dropbox commands | ||
figma | Figma commands | ||
github | GitHub commands | ||
license | Show license information | ||
local | Commands for local PC | ||
log | Log utilities | ||
slack | Slack commands | ||
util | Utilities | ||
version | Show version | \n |
Dropbox Business file lock information
Command | Description |
---|---|
dropbox team member file lock all release | Release all file locks held by a team member under a specified path, resolving editing conflicts |
dropbox team member file lock list | Display all files locked by a specific team member under a given path, identifying potential collaboration blocks |
dropbox team member file lock release | Release a specific file lock held by a team member, enabling others to edit the file |
Command | Description |
---|---|
dropbox team teamfolder file list | Display all files and subfolders within team folders for content inventory and management |
dropbox team teamfolder file lock all release | Release all file locks within a team folder path, resolving editing conflicts in bulk |
dropbox team teamfolder file lock list | Display all locked files within team folders, identifying collaboration bottlenecks |
dropbox team teamfolder file lock release | Release specific file locks in team folders to enable collaborative editing |
The team activity log commands can export activity logs by certain filters or perspectives.
Command | Description |
---|---|
dropbox team activity batch user | Scan and retrieve activity logs for multiple team members in batch, useful for compliance auditing and user behavior analysis |
dropbox team activity daily event | Generate daily activity reports showing team events grouped by date, helpful for tracking team usage patterns and security monitoring |
dropbox team activity event | Retrieve detailed team activity event logs with filtering options, essential for security auditing and compliance monitoring |
dropbox team activity user | Retrieve activity logs for specific team members, showing their file operations, logins, and sharing activities |
The below commands can retrieve information about connected devices or applications in the team.
Command | Description |
---|---|
dropbox team device list | Display all devices and active sessions connected to team member accounts with device details and last activity timestamps |
dropbox team device unlink | Remotely disconnect devices from team member accounts, essential for securing lost/stolen devices or revoking access |
dropbox team linkedapp list | Display all third-party applications linked to team member accounts for security auditing and access control |
dropbox team backup device status | Track Dropbox Backup status changes for all team devices over a specified period, monitoring backup health and compliance |
External ID is the attribute that is not shown in any user interface of Dropbox. This attribute is for keeping a relationship between Dropbox and identity source (e.g. Active Directory, HR database) by identity management software such as Dropbox AD Connector. If you are using Dropbox AD Connector and you built a new Active Directory tree. You may need to clear existing external IDs to disconnect relationships with the old Active Directory tree and the new tree.\nIf you skip clear external IDs, Dropbox AD Connector may unintentionally delete accounts during configuring to the new tree.\nIf you want to see existing external IDs, use the dropbox team member list
command. But the command will not include external ID by default. Please add the option -experiment report_all_columns
like below.\n\n\n
Command | Description |
---|---|
dropbox team member list | Display comprehensive list of all team members with their status, roles, and account details |
dropbox team member clear externalid | Remove external ID mappings from team members, useful when disconnecting from identity management systems |
dropbox team member update batch externalid | Set or update external IDs for multiple team members, integrating with identity management systems |
dropbox team group list | Display all groups in your team with member counts and group management types |
dropbox team group clear externalid | Remove external ID mappings from groups, useful when disconnecting from external identity providers |
Data migration helper commands copies member folders or team folders to another account or team. Please test before using those commands before actual data migration.
Command | Description |
---|---|
dropbox team member folder replication | Copy folder contents from one team member to another’s personal space, facilitating content transfer and backup |
dropbox team member replication | Replicate all files from one team member’s account to another, useful for account transitions or backups |
dropbox team teamfolder partial replication | Selectively replicate team folder contents to another team, enabling flexible content migration |
dropbox team teamfolder replication | Copy an entire team folder with all contents to another team account for migration or backup |
Command | Description |
---|---|
dropbox team feature | Display all features and capabilities enabled for your Dropbox team account, including API limits and special features |
dropbox team filesystem | Identify whether your team uses legacy or modern file system architecture, important for feature compatibility |
dropbox team info | Display essential team account information including team ID and basic team settings |
Commands for a team’s legacy Paper content. Please see the official guide for more details about legacy Paper and migration
Command | Description |
---|---|
dropbox team content legacypaper count | Calculate the total number of legacy Paper documents owned by each team member, useful for content auditing and migration planning |
dropbox team content legacypaper list | Generate a comprehensive list of all legacy Paper documents across the team with ownership and metadata information |
dropbox team content legacypaper export | Export all legacy Paper documents from team members to local storage in HTML or Markdown format for backup or migration |
Below commands are for managing team admins.
Command | Description |
---|---|
dropbox team admin list | Display all team members with their assigned admin roles, helpful for auditing administrative access and permissions |
dropbox team admin role add | Grant a specific admin role to an individual team member, enabling granular permission management |
dropbox team admin role clear | Revoke all administrative privileges from a team member, useful for role transitions or security purposes |
dropbox team admin role delete | Remove a specific admin role from a team member while preserving other roles, allowing precise permission adjustments |
dropbox team admin role list | Display all available admin roles in the team with their descriptions and permissions |
dropbox team admin group role add | Assign admin roles to all members of a specified group, streamlining role management for large teams |
dropbox team admin group role delete | Remove admin roles from all team members except those in a specified exception group, useful for role cleanup and access control |
You can run a command as a team member. For example, you can upload a file into member’s folder by using dropbox team runas file sync batch up
.
Command | Description |
---|---|
dropbox team runas file list | List files and folders in a team member’s account by running operations as that member |
dropbox team runas file batch copy | Copy multiple files or folders on behalf of team members, useful for content management and organization |
dropbox team runas file sync batch up | Upload multiple local files to team members’ Dropbox accounts in batch, running as those members |
dropbox team runas sharedfolder list | Display all shared folders accessible by a team member, running the operation as that member |
dropbox team runas sharedfolder isolate | Remove all shared folder access for a team member and transfer ownership, useful for departing employees |
dropbox team runas sharedfolder mount add | Mount shared folders to team members’ accounts on their behalf, ensuring proper folder synchronization |
dropbox team runas sharedfolder mount delete | Unmount shared folders from team members’ accounts on their behalf, managing folder synchronization |
dropbox team runas sharedfolder mount list | Display all shared folders currently mounted (synced) to a specific team member’s account |
dropbox team runas sharedfolder mount mountable | Show all available shared folders that a team member can mount but hasn’t synced yet |
dropbox team runas sharedfolder batch leave | Remove team members from multiple shared folders in batch by running leave operations as those members |
dropbox team runas sharedfolder batch share | Share multiple folders on behalf of team members in batch, automating folder sharing processes |
dropbox team runas sharedfolder batch unshare | Remove sharing from multiple folders on behalf of team members, managing folder access in bulk |
dropbox team runas sharedfolder member batch add | Add multiple members to shared folders in batch on behalf of folder owners, streamlining access management |
dropbox team runas sharedfolder member batch delete | Remove multiple members from shared folders in batch on behalf of folder owners, managing access efficiently |
With legal holds, admins can place a legal hold on members of their team and view and export all the content that’s been created or modified by those members.
Command | Description |
---|---|
dropbox team legalhold add | Create a legal hold policy to preserve specified team content for compliance or litigation purposes |
dropbox team legalhold list | Display all active legal hold policies with their details, members, and preservation status |
dropbox team legalhold member batch update | Add or remove multiple team members from legal hold policies in batch for efficient compliance management |
dropbox team legalhold member list | Display all team members currently under legal hold policies with their preservation status |
dropbox team legalhold release | Release a legal hold policy and restore normal file operations for affected members and content |
dropbox team legalhold revision list | Display all file revisions preserved under legal hold policies, ensuring comprehensive data retention |
dropbox team legalhold update desc | Modify the description of an existing legal hold policy to reflect changes in scope or purpose |
dropbox team legalhold update name | Change the name of a legal hold policy for better identification and organization |
Dropbox Business footnote information