Dropbox for HTTP Developers

file_properties

team

team_log

deprecated

Dropbox Business API

The Dropbox Business API allows apps to manage the user lifecycle for a Dropbox Business account and perform API actions on all members of a team. It also gives apps programmatic access to Dropbox Business admin functionality.

Access types

There are four different access types of Dropbox Business API permissions. You should only request access to the minimum set of permissions that your app requires:

  • Team information – Information about the team and aggregate usage data
  • Team auditing – Team information, plus the team's detailed activity log
  • Team member file access – Team information and auditing, plus the ability to perform any action as any team member
  • Team member management – Team information, plus the ability to add, edit, and delete team members

Creating an application

To create a Dropbox Business app, visit the app creation page.

Testing your application

To test an app that calls the Dropbox Business API endpoints, you can request a free Dropbox Business Development Account here. This will allow you to test your app using a standard Dropbox Business team. Development accounts are granted on a by-request basis and are contingent on additional terms and conditions outlined in the request form.

Linking to a team

Developers will need to direct a Dropbox Business team administrator through the standard OAuth 2.0 flow to install their application on a Dropbox Business team. The OAuth response/redirect will include an additional team_id field that can be used to uniquely identify a team.

Dropbox Business API OAuth tokens can enable extensive access to team data, so it is your responsibility to properly secure them server-side. They should never be cached in insecure environments or downloaded to client devices.

Member file access

A Dropbox Business app can make calls to the Dropbox API for any member of the Dropbox Business team. Your app must have Team member file access permission.

To make calls on a member's behalf, use the OAuth token granted to the app by the team. Specify the member_id of the user that the app wants to act on using a custom HTTP header called Dropbox-API-Select-User.

Notes:

  • This feature is currently limited to only team members in the "active" state.
  • A common use case for Team member file access is scanning through member Dropbox accounts. The recommended approach for this is repeated calls to /files/list_folder/continue.

An additional error may occur when using Dropbox-API-Select-User:

  • 401 Member ID doesn't exist on the team.

An alternative and advanced method for Business API apps to access and perform operations on team-owned content is to use the Dropbox-API-Select-Admin HTTP header instead of Dropbox-API-Select-User.

There are a several key differences between the two:

First, both headers specify the member_id of a team member in their values, but for Dropbox-API-Select-Admin this must refer to a team admin rather than an arbitrary member.

Second, Dropbox-API-Select-User allows access to and operations on content that currently exists in the "selected" team member's Dropbox. This includes their private files and folders as well as contents of any shared or team folders they not only have access to but also have added to their Dropbox (i.e. "mounted" in API terms).

In contrast, Dropbox-API-Select-Admin allows access to and operations on any team-owned content, including unmounted content. This includes any team member's private files and folders as well as contents of any shared folders owned by a member of the team and team folders. In particular, the team admin being impersonated doesn't have to have the target content in their Dropbox and doesn't have to be in the membership of any shared or team folders the content might reside in.

Specifically, there are two different modes for Dropbox-API-Select-Admin header:

  • Whole Team The endpoint can access content of team folders as well as team member's private files.
  • Team Admin The endpoint can access content of team folders but not team member's private files.

The supported Dropbox-API-Select-Admin mode for each API endpoint is documented under Authentication section.

In general, Whole Team is supported by read-only endpoints in order to simplify referring to and traversing team-owned content. Conversely, Team Admin is supported by mutable calls in order to perform particular actions an administrator (rather than user) - which may be a required permission for some operations within team spaces.

Since traditional logical paths in Dropbox must refer to mounted content, the endpoints that support the Dropbox-API-Select-Admin header accept namespace-relative paths. These take the format of ns:<namespace_id><namespace_path>, where <namespace_id> is the shared_folder_id or team_folder_id of the shared folder or the team folder containing the file or folder, respectively, and <namespace_path> is the logical path to the content relative to its shared folder or team folder container. See our namespace guide for more information.

Note that not all User API endpoints support the Dropbox-API-Select-Admin header. Check the API docs for a list of endpoints that do.

Production status

When first created, an app will be in "Development" mode, which means it will only be able to link to a single team. You can enable up to 5 additional development teams from your app's info page on the App Console by clicking Enable additional teams. When you are ready to exit development and deploy your app more broadly, you will need to apply for Production status.

Webhooks

Dropbox Business API apps that have specified a webhook URL in the App Console will receive change notifications for the team. There are two classes of change notifications, each associated with different permissions.

Team member file access notifications

Apps with the Team member file access permission will receive per-user webhook notifications from all members of the team. The webhook notification contains a list of all member_ids that have changes within their account. This is similar to the Dropbox API webhooks behavior.

For Team member file access notifications, your endpoint will receive JSON with the following format:

{
  "list_folder": {
    "teams": {
      "team_id1": [
        "member_id1",
        "member_id2",
        ...
      ],
      "team_id2": [
        "member_id1",
        "member_id2",
        ...
      ],
      ...
    }
  },
  "delta": {
    "teams": {
      "team_id1": [
        "member_id1",
        "member_id2",
        ...
      ],
      "team_id2": [
        "member_id1",
        "member_id2",
        ...
      ],
      ...
    }
  }
}

Note that a single change to a file in a shared folder will trigger a webhook for each user that the folder is shared with (and will also show up in the /list_folder entries for each account). You may want to track these occurrences to avoid re-processing the same file multiple times. One possible method would be to track a combination of the (unique) shared folder ID, file path, and rev for a file to identify if it is the same as a previously-processed change. Files outside a shared folder don't have this concern.

Team change notifications

Apps with Team member management or Team member file access permissions will receive webhook notifications for changes to the team membership. This type of notification will be triggered in the following cases:

  • User is invited to team
  • User joins team (transitions from "invited" to "active" status)
  • User is removed from team
  • User's profile or permissions are updated

For Team change notifications, your endpoint will receive JSON with the following format:

{
  "team_events": [
    {
      "event": "member_info_change",
      "team_id": "team_id1",
      "member_ids": [
        "member_id1",
        "member_id2",
        ...
      ]
    },
    ...
  ]
}

account

auth

contacts

file_properties

This namespace contains helpers for property and template metadata endpoints.

These endpoints enable you to tag arbitrary key/value data to Dropbox files.

The most basic unit in this namespace is the PropertyField. These fields encapsulate the actual key/value data.

Fields are added to a Dropbox file using a PropertyGroup. Property groups contain a reference to a Dropbox file and a PropertyGroupTemplate. Property groups are uniquely identified by the combination of their associated Dropbox file and template.

The PropertyGroupTemplate is a way of restricting the possible key names and value types of the data within a property group. The possible key names and value types are explicitly enumerated using PropertyFieldTemplate objects.

You can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects.

Templates are owned either by a user/app pair or team/app pair. Templates and their associated properties can't be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team).

User-owned templates are accessed via the user-auth file_properties/templates/*_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/*_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints.

Finally, properties can be accessed from a number of endpoints that return metadata, including `files/get_metadata`, and `files/list_folder`. Properties can also be added during upload, using `files/upload`.

/templates/add_for_team

Version
Description

Add a template associated with a team. See properties/add to add properties to a file or folder.
Note: this endpoint will create team-owned templates.

URL Structure
https://api.dropboxapi.com/2/file_properties/templates/add_for_team
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/file_properties/templates/add_for_team \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"name\": \"Security\",\"description\": \"These properties describe how confidential this file or folder is.\",\"fields\": [{\"name\": \"Security Policy\",\"description\": \"This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.\",\"type\": \"string\"}]}"
Parameters
{
    "name": "Security",
    "description": "These properties describe how confidential this file or folder is.",
    "fields": [
        {
            "name": "Security Policy",
            "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.",
            "type": "string"
        }
    ]
}
AddTemplateArg
name String Display name for the template. Template names can be up to 256 bytes.
description String Description for the template. Template descriptions can be up to 1024 bytes.
fields List of (PropertyFieldTemplate) Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.
PropertyFieldTemplate
Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.
name String Key of the property field being described. Property field keys can be up to 256 bytes.
description String Description of the property field. Property field descriptions can be up to 1024 bytes.
type PropertyType Data type of the value of this property field. This type will be enforced upon property creation and modifications.
PropertyType (open union)
Data type of the given property field added. The value will be one of the following datatypes. New values may be introduced as our API evolves.
string Void The associated property field will be of type string. Unicode is supported.
Returns
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
AddTemplateResult
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for template added by See templates/add_for_user or templates/add_for_team.
Errors
Example: restricted_content
{
    "error_summary": "restricted_content/...",
    "error": {
        ".tag": "restricted_content"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: conflicting_property_names
{
    "error_summary": "conflicting_property_names/...",
    "error": {
        ".tag": "conflicting_property_names"
    }
}
Example: too_many_properties
{
    "error_summary": "too_many_properties/...",
    "error": {
        ".tag": "too_many_properties"
    }
}
Example: too_many_templates
{
    "error_summary": "too_many_templates/...",
    "error": {
        ".tag": "too_many_templates"
    }
}
Example: template_attribute_too_large
{
    "error_summary": "template_attribute_too_large/...",
    "error": {
        ".tag": "template_attribute_too_large"
    }
}
ModifyTemplateError (union)
The value will be one of the following datatypes:
template_not_found String(min_length=1, pattern="(/|ptid:).*") Template does not exist for the given identifier.
restricted_content Void You do not have permission to modify this template.
conflicting_property_names Void A property field key with that name already exists in the template.
too_many_properties Void There are too many properties in the changed template. The maximum number of properties per template is 32.
too_many_templates Void There are too many templates for the team.
template_attribute_too_large Void The template name, description or one or more of the property field keys is too large.

/templates/get_for_team

Version
Description

Get the schema for a specified template.

URL Structure
https://api.dropboxapi.com/2/file_properties/templates/get_for_team
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/file_properties/templates/get_for_team \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"template_id\": \"ptid:1a5n2i6d3OYEAAAAAAAAAYa\"}"
Parameters
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
GetTemplateArg
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for template added by route See templates/add_for_user or templates/add_for_team.
Returns
{
    "name": "Security",
    "description": "These properties describe how confidential this file or folder is.",
    "fields": [
        {
            "name": "Security Policy",
            "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.",
            "type": {
                ".tag": "string"
            }
        }
    ]
}
GetTemplateResult
name String Display name for the template. Template names can be up to 256 bytes.
description String Description for the template. Template descriptions can be up to 1024 bytes.
fields List of (PropertyFieldTemplate) Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.
PropertyFieldTemplate
Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.
name String Key of the property field being described. Property field keys can be up to 256 bytes.
description String Description of the property field. Property field descriptions can be up to 1024 bytes.
type PropertyType Data type of the value of this property field. This type will be enforced upon property creation and modifications.
PropertyType (open union)
Data type of the given property field added. The value will be one of the following datatypes. New values may be introduced as our API evolves.
string Void The associated property field will be of type string. Unicode is supported.
Errors
Example: restricted_content
{
    "error_summary": "restricted_content/...",
    "error": {
        ".tag": "restricted_content"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TemplateError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
template_not_found String(min_length=1, pattern="(/|ptid:).*") Template does not exist for the given identifier.
restricted_content Void You do not have permission to modify this template.

/templates/list_for_team

Version
Description

Get the template identifiers for a team. To get the schema of each template use templates/get_for_team.

URL Structure
https://api.dropboxapi.com/2/file_properties/templates/list_for_team
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/file_properties/templates/list_for_team \
    --header "Authorization: Bearer "
Parameters

No parameters.

Returns
{
    "template_ids": [
        "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
    ]
}
ListTemplateResult
template_ids List of (String(min_length=1, pattern="(/|ptid:).*")) List of identifiers for templates added by See templates/add_for_user or templates/add_for_team.
Errors
Example: restricted_content
{
    "error_summary": "restricted_content/...",
    "error": {
        ".tag": "restricted_content"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TemplateError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
template_not_found String(min_length=1, pattern="(/|ptid:).*") Template does not exist for the given identifier.
restricted_content Void You do not have permission to modify this template.

/templates/remove_for_team

Version
Description

Permanently removes the specified template created from templates/add_for_user. All properties associated with the template will also be removed. This action cannot be undone.

URL Structure
https://api.dropboxapi.com/2/file_properties/templates/remove_for_team
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/file_properties/templates/remove_for_team \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"template_id\": \"ptid:1a5n2i6d3OYEAAAAAAAAAYa\"}"
Parameters
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
RemoveTemplateArg
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for a template created by templates/add_for_user or templates/add_for_team.
Returns

No return values.

Errors
Example: restricted_content
{
    "error_summary": "restricted_content/...",
    "error": {
        ".tag": "restricted_content"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TemplateError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
template_not_found String(min_length=1, pattern="(/|ptid:).*") Template does not exist for the given identifier.
restricted_content Void You do not have permission to modify this template.

/templates/update_for_team

Version
Description

Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates.

URL Structure
https://api.dropboxapi.com/2/file_properties/templates/update_for_team
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/file_properties/templates/update_for_team \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"template_id\": \"ptid:1a5n2i6d3OYEAAAAAAAAAYa\",\"name\": \"New Security Template Name\",\"description\": \"These properties will describe how confidential this file or folder is.\",\"add_fields\": [{\"name\": \"Security Policy\",\"description\": \"This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.\",\"type\": \"string\"}]}"
Parameters
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa",
    "name": "New Security Template Name",
    "description": "These properties will describe how confidential this file or folder is.",
    "add_fields": [
        {
            "name": "Security Policy",
            "description": "This is the security policy of the file or folder described.\nPolicies can be Confidential, Public or Internal.",
            "type": "string"
        }
    ]
}
UpdateTemplateArg
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for template added by See templates/add_for_user or templates/add_for_team.
name String? A display name for the template. template names can be up to 256 bytes. This field is optional.
description String? Description for the new template. Template descriptions can be up to 1024 bytes. This field is optional.
add_fields List of (PropertyFieldTemplate)? Property field templates to be added to the group template. There can be up to 32 properties in a single template. This field is optional.
PropertyFieldTemplate
Defines how a single property field may be structured. Used exclusively by PropertyGroupTemplate.
name String Key of the property field being described. Property field keys can be up to 256 bytes.
description String Description of the property field. Property field descriptions can be up to 1024 bytes.
type PropertyType Data type of the value of this property field. This type will be enforced upon property creation and modifications.
PropertyType (open union)
Data type of the given property field added. The value will be one of the following datatypes. New values may be introduced as our API evolves.
string Void The associated property field will be of type string. Unicode is supported.
Returns
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
UpdateTemplateResult
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for template added by route See templates/add_for_user or templates/add_for_team.
Errors
Example: restricted_content
{
    "error_summary": "restricted_content/...",
    "error": {
        ".tag": "restricted_content"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: conflicting_property_names
{
    "error_summary": "conflicting_property_names/...",
    "error": {
        ".tag": "conflicting_property_names"
    }
}
Example: too_many_properties
{
    "error_summary": "too_many_properties/...",
    "error": {
        ".tag": "too_many_properties"
    }
}
Example: too_many_templates
{
    "error_summary": "too_many_templates/...",
    "error": {
        ".tag": "too_many_templates"
    }
}
Example: template_attribute_too_large
{
    "error_summary": "template_attribute_too_large/...",
    "error": {
        ".tag": "template_attribute_too_large"
    }
}
ModifyTemplateError (union)
The value will be one of the following datatypes:
template_not_found String(min_length=1, pattern="(/|ptid:).*") Template does not exist for the given identifier.
restricted_content Void You do not have permission to modify this template.
conflicting_property_names Void A property field key with that name already exists in the template.
too_many_properties Void There are too many properties in the changed template. The maximum number of properties per template is 32.
too_many_templates Void There are too many templates for the team.
template_attribute_too_large Void The template name, description or one or more of the property field keys is too large.

file_requests

This namespace contains endpoints and data types for file request operations.

files

This namespace contains endpoints and data types for basic file operations.

paper

This namespace contains endpoints and data types for managing docs and folders in Dropbox Paper.

sharing

This namespace contains endpoints and data types for creating and managing shared links and shared folders.

team

/devices/list_member_devices

Version
Description

List all device sessions of a team's member.

URL Structure
https://api.dropboxapi.com/2/team/devices/list_member_devices
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/devices/list_member_devices \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_member_id\": \"dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I\",\"include_web_sessions\": true,\"include_desktop_clients\": true,\"include_mobile_clients\": true}"
Parameters
{
    "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I",
    "include_web_sessions": true,
    "include_desktop_clients": true,
    "include_mobile_clients": true
}
ListMemberDevicesArg
team_member_id String The team's member id.
include_web_sessions Boolean Whether to list web sessions of the team's member. The default for this field is True.
include_desktop_clients Boolean Whether to list linked desktop devices of the team's member. The default for this field is True.
include_mobile_clients Boolean Whether to list linked mobile devices of the team's member. The default for this field is True.
Returns
ListMemberDevicesResult
active_web_sessions List of (ActiveWebSession)? List of web sessions made by this team member. This field is optional.
ActiveWebSession
Information on active web sessions.
session_id String The session id.
user_agent String Information on the hosting device.
os String Information on the hosting operating system.
browser String Information on the browser used for this web session.
ip_address String? The IP address of the last activity from this session. This field is optional.
country String? The country from which the last activity from this session was made. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. This field is optional.
expires Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session expires. This field is optional.
desktop_client_sessions List of (DesktopClientSession)? List of desktop clients used by this team member. This field is optional.
DesktopClientSession
Information about linked Dropbox desktop client sessions.
session_id String The session id.
host_name String Name of the hosting desktop.
client_type DesktopPlatform The Dropbox desktop client type.
DesktopPlatform (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
windows Void Official Windows Dropbox desktop client.
mac Void Official Mac Dropbox desktop client.
linux Void Official Linux Dropbox desktop client.
client_version String The Dropbox client version.
platform String Information on the hosting platform.
is_delete_on_unlink_supported Boolean Whether it's possible to delete all of the account files upon unlinking.
ip_address String? The IP address of the last activity from this session. This field is optional.
country String? The country from which the last activity from this session was made. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. This field is optional.
mobile_client_sessions List of (MobileClientSession)? List of mobile client used by this team member. This field is optional.
MobileClientSession
Information about linked Dropbox mobile client sessions.
session_id String The session id.
device_name String The device name.
client_type MobileClientPlatform The mobile application type.
MobileClientPlatform (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
iphone Void Official Dropbox iPhone client.
ipad Void Official Dropbox iPad client.
android Void Official Dropbox Android client.
windows_phone Void Official Dropbox Windows phone client.
blackberry Void Official Dropbox Blackberry client.
ip_address String? The IP address of the last activity from this session. This field is optional.
country String? The country from which the last activity from this session was made. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. This field is optional.
client_version String? The dropbox client version. This field is optional.
os_version String? The hosting OS version. This field is optional.
last_carrier String? last carrier used by the device. This field is optional.
Errors
Example: member_not_found
{
    "error_summary": "member_not_found/...",
    "error": {
        ".tag": "member_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ListMemberDevicesError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
member_not_found Void Member not found.

/devices/list_members_devices

Version
Description

List all device sessions of a team.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/devices/list_members_devices
Authentication
Team Authentication
Endpoint format
RPC
Parameters
ListMembersDevicesArg
cursor String? At the first call to the devices/list_members_devices the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of team devices. This field is optional.
include_web_sessions Boolean Whether to list web sessions of the team members. The default for this field is True.
include_desktop_clients Boolean Whether to list desktop clients of the team members. The default for this field is True.
include_mobile_clients Boolean Whether to list mobile clients of the team members. The default for this field is True.
Returns
ListMembersDevicesResult
devices List of (MemberDevices) The devices of each member of the team.
MemberDevices
Information on devices of a team's member.
team_member_id String The member unique Id.
web_sessions List of (ActiveWebSession)? List of web sessions made by this team member. This field is optional.
ActiveWebSession
Information on active web sessions.
session_id String The session id.
user_agent String Information on the hosting device.
os String Information on the hosting operating system.
browser String Information on the browser used for this web session.
ip_address String? The IP address of the last activity from this session. This field is optional.
country String? The country from which the last activity from this session was made. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. This field is optional.
expires Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session expires. This field is optional.
desktop_clients List of (DesktopClientSession)? List of desktop clients by this team member. This field is optional.
DesktopClientSession
Information about linked Dropbox desktop client sessions.
session_id String The session id.
host_name String Name of the hosting desktop.
client_type DesktopPlatform The Dropbox desktop client type.
DesktopPlatform (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
windows Void Official Windows Dropbox desktop client.
mac Void Official Mac Dropbox desktop client.
linux Void Official Linux Dropbox desktop client.
client_version String The Dropbox client version.
platform String Information on the hosting platform.
is_delete_on_unlink_supported Boolean Whether it's possible to delete all of the account files upon unlinking.
ip_address String? The IP address of the last activity from this session. This field is optional.
country String? The country from which the last activity from this session was made. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. This field is optional.
mobile_clients List of (MobileClientSession)? List of mobile clients by this team member. This field is optional.
MobileClientSession
Information about linked Dropbox mobile client sessions.
session_id String The session id.
device_name String The device name.
client_type MobileClientPlatform The mobile application type.
MobileClientPlatform (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
iphone Void Official Dropbox iPhone client.
ipad Void Official Dropbox iPad client.
android Void Official Dropbox Android client.
windows_phone Void Official Dropbox Windows phone client.
blackberry Void Official Dropbox Blackberry client.
ip_address String? The IP address of the last activity from this session. This field is optional.
country String? The country from which the last activity from this session was made. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. This field is optional.
client_version String? The dropbox client version. This field is optional.
os_version String? The hosting OS version. This field is optional.
last_carrier String? last carrier used by the device. This field is optional.
has_more Boolean If true, then there are more devices available. Pass the cursor to devices/list_members_devices to retrieve the rest.
cursor String? Pass the cursor into devices/list_members_devices to receive the next sub list of team's devices. This field is optional.
Errors
Example: reset
{
    "error_summary": "reset/...",
    "error": {
        ".tag": "reset"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ListMembersDevicesError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
reset Void Indicates that the cursor has been invalidated. Call devices/list_members_devices again with an empty cursor to obtain a new cursor.

/devices/revoke_device_session

Version
Description

Revoke a device session of a team's member.

URL Structure
https://api.dropboxapi.com/2/team/devices/revoke_device_session
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/devices/revoke_device_session \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\".tag\": \"web_session\",\"session_id\": \"1234faaf0678bcde\",\"team_member_id\": \"dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU\"}"
Parameters
{
    ".tag": "web_session",
    "session_id": "1234faaf0678bcde",
    "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU"
}
RevokeDeviceSessionArg (union)
The value will be one of the following datatypes:
web_session DeviceSessionArg End an active session.
DeviceSessionArg
session_id String The session id.
team_member_id String The unique id of the member owning the device.
desktop_client RevokeDesktopClientArg Unlink a linked desktop device.
RevokeDesktopClientArg
session_id String The session id.
team_member_id String The unique id of the member owning the device.
delete_on_unlink Boolean Whether to delete all files of the account (this is possible only if supported by the desktop client and will be made the next time the client access the account). The default for this field is False.
mobile_client DeviceSessionArg Unlink a linked mobile device.
DeviceSessionArg
session_id String The session id.
team_member_id String The unique id of the member owning the device.
Returns

No return values.

Errors
Example: device_session_not_found
{
    "error_summary": "device_session_not_found/...",
    "error": {
        ".tag": "device_session_not_found"
    }
}
Example: member_not_found
{
    "error_summary": "member_not_found/...",
    "error": {
        ".tag": "member_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
RevokeDeviceSessionError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
device_session_not_found Void Device session not found.
member_not_found Void Member not found.

/devices/revoke_device_session_batch

Version
Description

Revoke a list of device sessions of team members.

URL Structure
https://api.dropboxapi.com/2/team/devices/revoke_device_session_batch
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/devices/revoke_device_session_batch \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"revoke_devices\": [{\".tag\": \"web_session\",\"session_id\": \"1234faaf0678bcde\",\"team_member_id\": \"dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU\"}]}"
Parameters
{
    "revoke_devices": [
        {
            ".tag": "web_session",
            "session_id": "1234faaf0678bcde",
            "team_member_id": "dbmid:AAHhy7WsR0x-u4ZCqiDl5Fz5zvuL3kmspwU"
        }
    ]
}
RevokeDeviceSessionBatchArg
revoke_devices List of (RevokeDeviceSessionArg)
RevokeDeviceSessionArg (union)
The value will be one of the following datatypes:
web_session DeviceSessionArg End an active session.
DeviceSessionArg
session_id String The session id.
team_member_id String The unique id of the member owning the device.
desktop_client RevokeDesktopClientArg Unlink a linked desktop device.
RevokeDesktopClientArg
session_id String The session id.
team_member_id String The unique id of the member owning the device.
delete_on_unlink Boolean Whether to delete all files of the account (this is possible only if supported by the desktop client and will be made the next time the client access the account). The default for this field is False.
mobile_client DeviceSessionArg Unlink a linked mobile device.
DeviceSessionArg
session_id String The session id.
team_member_id String The unique id of the member owning the device.
Returns
RevokeDeviceSessionBatchResult
revoke_devices_status List of (RevokeDeviceSessionStatus)
RevokeDeviceSessionStatus
success Boolean Result of the revoking request.
error_type RevokeDeviceSessionError? The error cause in case of a failure. This field is optional.
RevokeDeviceSessionError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
device_session_not_found Void Device session not found.
member_not_found Void Member not found.
Errors
RevokeDeviceSessionBatchError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.

/features/get_values

Version
Description

Get the values for one or more featues. This route allows you to check your account's capability for what feature you can access or what value you have for certain features.
Permission : Team information.

URL Structure
https://api.dropboxapi.com/2/team/features/get_values
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/features/get_values \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"features\": [{\".tag\": \"upload_api_rate_limit\"},{\".tag\": \"has_team_shared_dropbox\"}]}"
Parameters
{
    "features": [
        {
            ".tag": "upload_api_rate_limit"
        },
        {
            ".tag": "has_team_shared_dropbox"
        }
    ]
}
FeaturesGetValuesBatchArg
features List of (Feature) A list of features in Feature. If the list is empty, this route will return FeaturesGetValuesBatchError.
Feature (open union)
A set of features that a Dropbox Business account may support. The value will be one of the following datatypes. New values may be introduced as our API evolves.
upload_api_rate_limit Void The number of upload API calls allowed per month.
has_team_shared_dropbox Void Does this team have a shared team root.
has_team_file_events Void Does this team have file events.
has_team_selective_sync Void Does this team have team selective sync enabled.
Returns
{
    "values": [
        {
            ".tag": "upload_api_rate_limit",
            "upload_api_rate_limit": {
                ".tag": "limit",
                "limit": 25000
            }
        },
        {
            ".tag": "has_team_shared_dropbox",
            "has_team_shared_dropbox": {
                ".tag": "has_team_shared_dropbox",
                "has_team_shared_dropbox": false
            }
        }
    ]
}
FeaturesGetValuesBatchResult
values List of (FeatureValue)
FeatureValue (open union)
The values correspond to entries in Feature. You may get different value according to your Dropbox Business plan. The value will be one of the following datatypes. New values may be introduced as our API evolves.
upload_api_rate_limit UploadApiRateLimitValue
UploadApiRateLimitValue (open union)
The value for Feature.upload_api_rate_limit. The value will be one of the following datatypes. New values may be introduced as our API evolves.
unlimited Void This team has unlimited upload API quota. So far both server version account and legacy account type have unlimited monthly upload api quota.
limit UInt32 The number of upload API calls allowed per month.
has_team_shared_dropbox HasTeamSharedDropboxValue
HasTeamSharedDropboxValue (open union)
The value for Feature.has_team_shared_dropbox. The value will be one of the following datatypes. New values may be introduced as our API evolves.
has_team_shared_dropbox Boolean Does this team have a shared team root.
has_team_file_events HasTeamFileEventsValue
HasTeamFileEventsValue (open union)
The value for Feature.has_team_file_events. The value will be one of the following datatypes. New values may be introduced as our API evolves.
enabled Boolean Does this team have file events.
has_team_selective_sync HasTeamSelectiveSyncValue
HasTeamSelectiveSyncValue (open union)
The value for Feature.has_team_selective_sync. The value will be one of the following datatypes. New values may be introduced as our API evolves.
has_team_selective_sync Boolean Does this team have team selective sync enabled.
Errors
Example: empty_features_list
{
    "error_summary": "empty_features_list/...",
    "error": {
        ".tag": "empty_features_list"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
FeaturesGetValuesBatchError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
empty_features_list Void At least one Feature must be included in the FeaturesGetValuesBatchArg.features list.

/get_info

Version
Description

Retrieves information about a team.

URL Structure
https://api.dropboxapi.com/2/team/get_info
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/get_info \
    --header "Authorization: Bearer "
Parameters

No parameters.

Returns
{
    "name": "Dropbox Inc.",
    "team_id": "dbtid:1234abcd",
    "num_licensed_users": 5,
    "num_provisioned_users": 2,
    "policies": {
        "sharing": {
            "shared_folder_member_policy": {
                ".tag": "team"
            },
            "shared_folder_join_policy": {
                ".tag": "from_anyone"
            },
            "shared_link_create_policy": {
                ".tag": "team_only"
            }
        },
        "emm_state": {
            ".tag": "disabled"
        },
        "office_addin": {
            ".tag": "disabled"
        }
    }
}
TeamGetInfoResult
name String The name of the team.
team_id String The ID of the team.
num_licensed_users UInt32 The number of licenses available to the team.
num_provisioned_users UInt32 The number of accounts that have been invited or are already active members of the team.
policies TeamMemberPolicies
TeamMemberPolicies
Policies governing team members. This datatype comes from an imported namespace originally defined in the team_policies namespace.
sharing TeamSharingPolicies Policies governing sharing.
TeamSharingPolicies
Policies governing sharing within and outside of the team. This datatype comes from an imported namespace originally defined in the team_policies namespace.
shared_folder_member_policy SharedFolderMemberPolicy Who can join folders shared by team members.
SharedFolderMemberPolicy (open union)
Policy governing who can be a member of a folder shared by a team member. This datatype comes from an imported namespace originally defined in the team_policies namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team Void Only a teammate can be a member of a folder shared by a team member.
anyone Void Anyone can be a member of a folder shared by a team member.
shared_folder_join_policy SharedFolderJoinPolicy Which shared folders team members can join.
SharedFolderJoinPolicy (open union)
Policy governing which shared folders a team member can join. This datatype comes from an imported namespace originally defined in the team_policies namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
from_team_only Void Team members can only join folders shared by teammates.
from_anyone Void Team members can join any shared folder, including those shared by users outside the team.
shared_link_create_policy SharedLinkCreatePolicy Who can view shared links owned by team members.
SharedLinkCreatePolicy (open union)
Policy governing the visibility of shared links. This policy can apply to newly created shared links, or all shared links. This datatype comes from an imported namespace originally defined in the team_policies namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default_public Void By default, anyone can access newly created shared links. No login will be required to access the shared links unless overridden.
default_team_only Void By default, only members of the same team can access newly created shared links. Login will be required to access the shared links unless overridden.
team_only Void Only members of the same team can access all shared links. Login will be required to access all shared links.
emm_state EmmState This describes the Enterprise Mobility Management (EMM) state for this team. This information can be used to understand if an organization is integrating with a third-party EMM vendor to further manage and apply restrictions upon the team's Dropbox usage on mobile devices. This is a new feature and in the future we'll be adding more new fields and additional documentation.
EmmState (open union)
This datatype comes from an imported namespace originally defined in the team_policies namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void Emm token is disabled.
optional Void Emm token is optional.
required Void Emm token is required.
office_addin OfficeAddInPolicy The admin policy around the Dropbox Office Add-In for this team.
OfficeAddInPolicy (open union)
This datatype comes from an imported namespace originally defined in the team_policies namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void Office Add-In is disabled.
enabled Void Office Add-In is enabled.
Errors

No errors.

/groups/create

Version
Description

Creates a new, empty group, with a requested name.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/create
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/create \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"group_name\": \"Europe sales\",\"group_external_id\": \"group-134\"}"
Parameters
{
    "group_name": "Europe sales",
    "group_external_id": "group-134"
}
GroupCreateArg
group_name String Group name.
group_external_id String? The creator of a team can associate an arbitrary external ID to the group. This field is optional.
group_management_type GroupManagementType? Whether the team can be managed by selected users, or only by team admins. This field is optional.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
Returns
{
    "group_name": "project launch",
    "group_id": "g:e2db7665347abcd600000000001a2b3c",
    "group_management_type": {
        ".tag": "user_managed"
    },
    "created": 1447255518000,
    "member_count": 5,
    "members": [
        {
            "profile": {
                "team_member_id": "dbmid:1234567",
                "email": "mary@lamb.com",
                "email_verified": true,
                "status": {
                    ".tag": "active"
                },
                "name": {
                    "given_name": "Franz",
                    "surname": "Ferdinand",
                    "familiar_name": "Franz",
                    "display_name": "Franz Ferdinand (Personal)",
                    "abbreviated_name": "FF"
                },
                "membership_type": {
                    ".tag": "full"
                },
                "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "secondary_emails": [
                    {
                        "email": "apple@orange.com",
                        "is_verified": true
                    },
                    {
                        "email": "banana@honeydew.com",
                        "is_verified": true
                    },
                    {
                        "email": "grape@strawberry.com",
                        "is_verified": false
                    }
                ],
                "joined_on": "2015-05-12T15:50:38Z",
                "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
            },
            "access_type": {
                ".tag": "member"
            }
        }
    ]
}
GroupFullInfo
Full description of a group.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
created UInt64 The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
members List of (GroupMemberInfo)? List of group members. This field is optional.
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
Errors
Example: group_name_already_used
{
    "error_summary": "group_name_already_used/...",
    "error": {
        ".tag": "group_name_already_used"
    }
}
Example: group_name_invalid
{
    "error_summary": "group_name_invalid/...",
    "error": {
        ".tag": "group_name_invalid"
    }
}
Example: external_id_already_in_use
{
    "error_summary": "external_id_already_in_use/...",
    "error": {
        ".tag": "external_id_already_in_use"
    }
}
Example: system_managed_group_disallowed
{
    "error_summary": "system_managed_group_disallowed/...",
    "error": {
        ".tag": "system_managed_group_disallowed"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
GroupCreateError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
group_name_already_used Void The requested group name is already being used by another group.
group_name_invalid Void Group name is empty or has invalid characters.
external_id_already_in_use Void The requested external ID is already being used by another group.
system_managed_group_disallowed Void System-managed group cannot be manually created.

/groups/delete

Version
Description

Deletes a group.
The group is deleted immediately. However the revoking of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/delete
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/delete \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\".tag\": \"group_id\",\"group_id\": \"g:e2db7665347abcd600000000001a2b3c\"}"
Parameters
{
    ".tag": "group_id",
    "group_id": "g:e2db7665347abcd600000000001a2b3c"
}
GroupSelector (union)
Argument for selecting a single group, either by group_id or by external group ID. The value will be one of the following datatypes:
group_id String Group ID.
group_external_id String External ID of the group.
Returns
Example: complete
{
    ".tag": "complete"
}
Example: async_job_id
{
    ".tag": "async_job_id",
    "async_job_id": "34g93hh34h04y384084"
}
LaunchEmptyResult (union)
Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes:
async_job_id String(min_length=1) This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete Void The job finished synchronously and successfully.
Errors
Example: group_not_found
{
    "error_summary": "group_not_found/...",
    "error": {
        ".tag": "group_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: system_managed_group_disallowed
{
    "error_summary": "system_managed_group_disallowed/...",
    "error": {
        ".tag": "system_managed_group_disallowed"
    }
}
Example: group_already_deleted
{
    "error_summary": "group_already_deleted/...",
    "error": {
        ".tag": "group_already_deleted"
    }
}
GroupDeleteError (union)
The value will be one of the following datatypes:
group_not_found Void No matching group found. No groups match the specified group ID.
system_managed_group_disallowed Void This operation is not supported on system-managed groups.
group_already_deleted Void This group has already been deleted.

/groups/get_info

Version
Description

Retrieves information about one or more groups. Note that the optional field GroupFullInfo.members is not returned for system-managed groups.
Permission : Team Information.

URL Structure
https://api.dropboxapi.com/2/team/groups/get_info
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/get_info \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\".tag\": \"group_ids\",\"group_ids\": [\"g:e2db7665347abcd600000000001a2b3c\",\"g:111111147abcd6000000000222222c\"]}"
Parameters
{
    ".tag": "group_ids",
    "group_ids": [
        "g:e2db7665347abcd600000000001a2b3c",
        "g:111111147abcd6000000000222222c"
    ]
}
GroupsSelector (union)
Argument for selecting a list of groups, either by group_ids, or external group IDs. The value will be one of the following datatypes:
group_ids List of (String) List of group IDs.
group_external_ids List of (String) List of external IDs of groups.
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
GroupsGetInfoItem (union)
The value will be one of the following datatypes:
id_not_found String An ID that was provided as a parameter to groups/get_info, and did not match a corresponding group. The ID can be a group ID, or an external ID, depending on how the method was called.
group_info GroupFullInfo Info about a group.
GroupFullInfo
Full description of a group.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
created UInt64 The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
members List of (GroupMemberInfo)? List of group members. This field is optional.
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
Errors
Example: group_not_on_team
{
    "error_summary": "group_not_on_team/...",
    "error": {
        ".tag": "group_not_on_team"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
GroupsGetInfoError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
group_not_on_team Void The group is not on your team.

/groups/job_status/get

Version
Description

Once an async_job_id is returned from groups/delete, groups/members/add , or groups/members/remove use this method to poll the status of granting/revoking group members' access to group-owned resources.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/job_status/get
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/job_status/get \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"async_job_id\": \"34g93hh34h04y384084\"}"
Parameters
{
    "async_job_id": "34g93hh34h04y384084"
}
PollArg
Arguments for methods that poll the status of an asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace.
async_job_id String(min_length=1) Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Returns
Example: complete
{
    ".tag": "complete"
}
Example: in_progress
{
    ".tag": "in_progress"
}
PollEmptyResult (union)
Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes:
in_progress Void The asynchronous job is still in progress.
complete Void The asynchronous job has completed successfully.
Errors
Example: invalid_async_job_id
{
    "error_summary": "invalid_async_job_id/...",
    "error": {
        ".tag": "invalid_async_job_id"
    }
}
Example: internal_error
{
    "error_summary": "internal_error/...",
    "error": {
        ".tag": "internal_error"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: access_denied
{
    "error_summary": "access_denied/...",
    "error": {
        ".tag": "access_denied"
    }
}
GroupsPollError (union)
The value will be one of the following datatypes:
invalid_async_job_id Void The job ID is invalid.
internal_error Void Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.
access_denied Void You are not allowed to poll this job.

/groups/list

Version
Description

Lists groups on a team.
Permission : Team Information.

URL Structure
https://api.dropboxapi.com/2/team/groups/list
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/list \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"limit\": 100}"
Parameters
{
    "limit": 100
}
GroupsListArg
limit UInt32(min=1, max=1000) Number of results to return per call. The default for this field is 1000.
Returns
{
    "groups": [
        {
            "group_name": "Test group",
            "group_id": "g:e2db7665347abcd600000000001a2b3c",
            "group_management_type": {
                ".tag": "user_managed"
            },
            "member_count": 10
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GroupsListResult
groups List of (GroupSummary)
GroupSummary
Information about a group. This datatype comes from an imported namespace originally defined in the team_common namespace.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
cursor String Pass the cursor into groups/list/continue to obtain the additional groups.
has_more Boolean Is true if there are additional groups that have not been returned yet. An additional call to groups/list/continue can retrieve them.
Errors

No errors.

/groups/list/continue

Version
Description

Once a cursor has been retrieved from groups/list, use this to paginate through all groups.
Permission : Team Information.

URL Structure
https://api.dropboxapi.com/2/team/groups/list/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/list/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
GroupsListContinueArg
cursor String Indicates from what point to get the next set of groups.
Returns
{
    "groups": [
        {
            "group_name": "Test group",
            "group_id": "g:e2db7665347abcd600000000001a2b3c",
            "group_management_type": {
                ".tag": "user_managed"
            },
            "member_count": 10
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GroupsListResult
groups List of (GroupSummary)
GroupSummary
Information about a group. This datatype comes from an imported namespace originally defined in the team_common namespace.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
cursor String Pass the cursor into groups/list/continue to obtain the additional groups.
has_more Boolean Is true if there are additional groups that have not been returned yet. An additional call to groups/list/continue can retrieve them.
Errors
Example: invalid_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
GroupsListContinueError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_cursor Void The cursor is invalid.

/groups/members/add

Version
Description

Adds members to a group.
The members are added immediately. However the granting of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/members/add
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/members/add \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"group\": {\".tag\": \"group_id\",\"group_id\": \"g:e2db7665347abcd600000000001a2b3c\"},\"members\": [{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"access_type\": \"member\"}],\"return_members\": true}"
Parameters
{
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "members": [
        {
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "access_type": "member"
        }
    ],
    "return_members": true
}
GroupMembersAddArg
group GroupSelector Group to which users will be added.
GroupSelector (union)
Argument for selecting a single group, either by group_id or by external group ID. The value will be one of the following datatypes:
group_id String Group ID.
group_external_id String External ID of the group.
members List of (MemberAccess) List of users to be added to the group.
MemberAccess
Specify access type a member should have when joined to a group.
user UserSelectorArg Identity of a user.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
access_type GroupAccessType Access type.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
return_members Boolean Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.
Returns
{
    "group_info": {
        "group_name": "project launch",
        "group_id": "g:e2db7665347abcd600000000001a2b3c",
        "group_management_type": {
            ".tag": "user_managed"
        },
        "created": 1447255518000,
        "member_count": 5,
        "members": [
            {
                "profile": {
                    "team_member_id": "dbmid:1234567",
                    "email": "mary@lamb.com",
                    "email_verified": true,
                    "status": {
                        ".tag": "active"
                    },
                    "name": {
                        "given_name": "Franz",
                        "surname": "Ferdinand",
                        "familiar_name": "Franz",
                        "display_name": "Franz Ferdinand (Personal)",
                        "abbreviated_name": "FF"
                    },
                    "membership_type": {
                        ".tag": "full"
                    },
                    "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                    "secondary_emails": [
                        {
                            "email": "apple@orange.com",
                            "is_verified": true
                        },
                        {
                            "email": "banana@honeydew.com",
                            "is_verified": true
                        },
                        {
                            "email": "grape@strawberry.com",
                            "is_verified": false
                        }
                    ],
                    "joined_on": "2015-05-12T15:50:38Z",
                    "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
                },
                "access_type": {
                    ".tag": "member"
                }
            }
        ]
    },
    "async_job_id": "99988877733388"
}
GroupMembersChangeResult
Result returned by groups/members/add and groups/members/remove.
group_info GroupFullInfo The group info after member change operation has been performed.
GroupFullInfo
Full description of a group.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
created UInt64 The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
members List of (GroupMemberInfo)? List of group members. This field is optional.
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
async_job_id String(min_length=1) An ID that can be used to obtain the status of granting/revoking group-owned resources.
Errors
Example: group_not_found
{
    "error_summary": "group_not_found/...",
    "error": {
        ".tag": "group_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: system_managed_group_disallowed
{
    "error_summary": "system_managed_group_disallowed/...",
    "error": {
        ".tag": "system_managed_group_disallowed"
    }
}
Example: duplicate_user
{
    "error_summary": "duplicate_user/...",
    "error": {
        ".tag": "duplicate_user"
    }
}
Example: group_not_in_team
{
    "error_summary": "group_not_in_team/...",
    "error": {
        ".tag": "group_not_in_team"
    }
}
Example: user_must_be_active_to_be_owner
{
    "error_summary": "user_must_be_active_to_be_owner/...",
    "error": {
        ".tag": "user_must_be_active_to_be_owner"
    }
}
GroupMembersAddError (union)
The value will be one of the following datatypes:
group_not_found Void No matching group found. No groups match the specified group ID.
system_managed_group_disallowed Void This operation is not supported on system-managed groups.
duplicate_user Void You cannot add duplicate users. One or more of the members you are trying to add is already a member of the group.
group_not_in_team Void Group is not in this team. You cannot add members to a group that is outside of your team.
members_not_in_team List of (String) These members are not part of your team. Currently, you cannot add members to a group if they are not part of your team, though this may change in a subsequent version. To add new members to your Dropbox Business team, use the members/add endpoint.
users_not_found List of (String) These users were not found in Dropbox.
user_must_be_active_to_be_owner Void A suspended user cannot be added to a group as GroupAccessType.owner.
user_cannot_be_manager_of_company_managed_group List of (String) A company-managed group cannot be managed by a user.

/groups/members/list

Version
Description

Lists members of a group.
Permission : Team Information.

URL Structure
https://api.dropboxapi.com/2/team/groups/members/list
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/members/list \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"group\": {\".tag\": \"group_id\",\"group_id\": \"g:e2db7665347abcd600000000001a2b3c\"},\"limit\": 100}"
Parameters
{
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "limit": 100
}
GroupsMembersListArg
group GroupSelector The group whose members are to be listed.
GroupSelector (union)
Argument for selecting a single group, either by group_id or by external group ID. The value will be one of the following datatypes:
group_id String Group ID.
group_external_id String External ID of the group.
limit UInt32(min=1, max=1000) Number of results to return per call. The default for this field is 1000.
Returns
{
    "members": [],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GroupsMembersListResult
members List of (GroupMemberInfo)
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
cursor String Pass the cursor into groups/members/list/continue to obtain additional group members.
has_more Boolean Is true if there are additional group members that have not been returned yet. An additional call to groups/members/list/continue can retrieve them.
Errors
Example: group_not_found
{
    "error_summary": "group_not_found/...",
    "error": {
        ".tag": "group_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
GroupSelectorError (open union)
Error that can be raised when GroupSelector is used. The value will be one of the following datatypes. New values may be introduced as our API evolves.
group_not_found Void No matching group found. No groups match the specified group ID.

/groups/members/list/continue

Version
Description

Once a cursor has been retrieved from groups/members/list, use this to paginate through all members of the group.
Permission : Team information.

URL Structure
https://api.dropboxapi.com/2/team/groups/members/list/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/members/list/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
GroupsMembersListContinueArg
cursor String Indicates from what point to get the next set of groups.
Returns
{
    "members": [],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GroupsMembersListResult
members List of (GroupMemberInfo)
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
cursor String Pass the cursor into groups/members/list/continue to obtain additional group members.
has_more Boolean Is true if there are additional group members that have not been returned yet. An additional call to groups/members/list/continue can retrieve them.
Errors
Example: invalid_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
GroupsMembersListContinueError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_cursor Void The cursor is invalid.

/groups/members/remove

Version
Description

Removes members from a group.
The members are removed immediately. However the revoking of group-owned resources may take additional time. Use the groups/job_status/get to determine whether this process has completed.
This method permits removing the only owner of a group, even in cases where this is not possible via the web client.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/members/remove
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/members/remove \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"group\": {\".tag\": \"group_id\",\"group_id\": \"g:e2db7665347abcd600000000001a2b3c\"},\"users\": [{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}],\"return_members\": true}"
Parameters
{
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "users": [
        {
            ".tag": "team_member_id",
            "team_member_id": "dbmid:efgh5678"
        }
    ],
    "return_members": true
}
GroupMembersRemoveArg
group GroupSelector Group from which users will be removed.
GroupSelector (union)
Argument for selecting a single group, either by group_id or by external group ID. The value will be one of the following datatypes:
group_id String Group ID.
group_external_id String External ID of the group.
users List of (UserSelectorArg) List of users to be removed from the group.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
return_members Boolean Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.
Returns
{
    "group_info": {
        "group_name": "project launch",
        "group_id": "g:e2db7665347abcd600000000001a2b3c",
        "group_management_type": {
            ".tag": "user_managed"
        },
        "created": 1447255518000,
        "member_count": 5,
        "members": [
            {
                "profile": {
                    "team_member_id": "dbmid:1234567",
                    "email": "mary@lamb.com",
                    "email_verified": true,
                    "status": {
                        ".tag": "active"
                    },
                    "name": {
                        "given_name": "Franz",
                        "surname": "Ferdinand",
                        "familiar_name": "Franz",
                        "display_name": "Franz Ferdinand (Personal)",
                        "abbreviated_name": "FF"
                    },
                    "membership_type": {
                        ".tag": "full"
                    },
                    "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                    "secondary_emails": [
                        {
                            "email": "apple@orange.com",
                            "is_verified": true
                        },
                        {
                            "email": "banana@honeydew.com",
                            "is_verified": true
                        },
                        {
                            "email": "grape@strawberry.com",
                            "is_verified": false
                        }
                    ],
                    "joined_on": "2015-05-12T15:50:38Z",
                    "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
                },
                "access_type": {
                    ".tag": "member"
                }
            }
        ]
    },
    "async_job_id": "99988877733388"
}
GroupMembersChangeResult
Result returned by groups/members/add and groups/members/remove.
group_info GroupFullInfo The group info after member change operation has been performed.
GroupFullInfo
Full description of a group.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
created UInt64 The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
members List of (GroupMemberInfo)? List of group members. This field is optional.
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
async_job_id String(min_length=1) An ID that can be used to obtain the status of granting/revoking group-owned resources.
Errors
Example: group_not_found
{
    "error_summary": "group_not_found/...",
    "error": {
        ".tag": "group_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: system_managed_group_disallowed
{
    "error_summary": "system_managed_group_disallowed/...",
    "error": {
        ".tag": "system_managed_group_disallowed"
    }
}
Example: member_not_in_group
{
    "error_summary": "member_not_in_group/...",
    "error": {
        ".tag": "member_not_in_group"
    }
}
Example: group_not_in_team
{
    "error_summary": "group_not_in_team/...",
    "error": {
        ".tag": "group_not_in_team"
    }
}
GroupMembersRemoveError (union)
The value will be one of the following datatypes:
group_not_found Void No matching group found. No groups match the specified group ID.
system_managed_group_disallowed Void This operation is not supported on system-managed groups.
member_not_in_group Void At least one of the specified users is not a member of the group.
group_not_in_team Void Group is not in this team. You cannot remove members from a group that is outside of your team.
members_not_in_team List of (String) These members are not part of your team.
users_not_found List of (String) These users were not found in Dropbox.

/groups/members/set_access_type

Version
Description

Sets a member's access type in a group.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/members/set_access_type
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/members/set_access_type \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"group\": {\".tag\": \"group_id\",\"group_id\": \"g:e2db7665347abcd600000000001a2b3c\"},\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"access_type\": \"member\",\"return_members\": true}"
Parameters
{
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "access_type": "member",
    "return_members": true
}
GroupMembersSetAccessTypeArg
group GroupSelector Specify a group.
GroupSelector (union)
Argument for selecting a single group, either by group_id or by external group ID. The value will be one of the following datatypes:
group_id String Group ID.
group_external_id String External ID of the group.
user UserSelectorArg Identity of a user that is a member of group.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
access_type GroupAccessType New group access type the user will have.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
return_members Boolean Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
GroupsGetInfoItem (union)
The value will be one of the following datatypes:
id_not_found String An ID that was provided as a parameter to groups/get_info, and did not match a corresponding group. The ID can be a group ID, or an external ID, depending on how the method was called.
group_info GroupFullInfo Info about a group.
GroupFullInfo
Full description of a group.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
created UInt64 The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
members List of (GroupMemberInfo)? List of group members. This field is optional.
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
Errors
Example: group_not_found
{
    "error_summary": "group_not_found/...",
    "error": {
        ".tag": "group_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: system_managed_group_disallowed
{
    "error_summary": "system_managed_group_disallowed/...",
    "error": {
        ".tag": "system_managed_group_disallowed"
    }
}
Example: member_not_in_group
{
    "error_summary": "member_not_in_group/...",
    "error": {
        ".tag": "member_not_in_group"
    }
}
Example: user_cannot_be_manager_of_company_managed_group
{
    "error_summary": "user_cannot_be_manager_of_company_managed_group/...",
    "error": {
        ".tag": "user_cannot_be_manager_of_company_managed_group"
    }
}
GroupMemberSetAccessTypeError (union)
The value will be one of the following datatypes:
group_not_found Void No matching group found. No groups match the specified group ID.
system_managed_group_disallowed Void This operation is not supported on system-managed groups.
member_not_in_group Void The specified user is not a member of this group.
user_cannot_be_manager_of_company_managed_group Void A company managed group cannot be managed by a user.

/groups/update

Version
Description

Updates a group's name and/or external ID.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/groups/update
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/groups/update \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"group\": {\".tag\": \"group_id\",\"group_id\": \"g:e2db7665347abcd600000000001a2b3c\"},\"return_members\": true,\"new_group_name\": \"Europe west sales\",\"new_group_external_id\": \"sales-234\",\"new_group_management_type\": \"company_managed\"}"
Parameters
{
    "group": {
        ".tag": "group_id",
        "group_id": "g:e2db7665347abcd600000000001a2b3c"
    },
    "return_members": true,
    "new_group_name": "Europe west sales",
    "new_group_external_id": "sales-234",
    "new_group_management_type": "company_managed"
}
GroupUpdateArgs
group GroupSelector Specify a group.
GroupSelector (union)
Argument for selecting a single group, either by group_id or by external group ID. The value will be one of the following datatypes:
group_id String Group ID.
group_external_id String External ID of the group.
return_members Boolean Whether to return the list of members in the group. Note that the default value will cause all the group members to be returned in the response. This may take a long time for large groups. The default for this field is True.
new_group_name String? Optional argument. Set group name to this if provided. This field is optional.
new_group_external_id String? Optional argument. New group external ID. If the argument is None, the group's external_id won't be updated. If the argument is empty string, the group's external id will be cleared. This field is optional.
new_group_management_type GroupManagementType? Set new group management type, if provided. This field is optional.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
Returns
{
    "group_name": "project launch",
    "group_id": "g:e2db7665347abcd600000000001a2b3c",
    "group_management_type": {
        ".tag": "user_managed"
    },
    "created": 1447255518000,
    "member_count": 5,
    "members": [
        {
            "profile": {
                "team_member_id": "dbmid:1234567",
                "email": "mary@lamb.com",
                "email_verified": true,
                "status": {
                    ".tag": "active"
                },
                "name": {
                    "given_name": "Franz",
                    "surname": "Ferdinand",
                    "familiar_name": "Franz",
                    "display_name": "Franz Ferdinand (Personal)",
                    "abbreviated_name": "FF"
                },
                "membership_type": {
                    ".tag": "full"
                },
                "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "secondary_emails": [
                    {
                        "email": "apple@orange.com",
                        "is_verified": true
                    },
                    {
                        "email": "banana@honeydew.com",
                        "is_verified": true
                    },
                    {
                        "email": "grape@strawberry.com",
                        "is_verified": false
                    }
                ],
                "joined_on": "2015-05-12T15:50:38Z",
                "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
            },
            "access_type": {
                ".tag": "member"
            }
        }
    ]
}
GroupFullInfo
Full description of a group.
group_name String
group_id String
group_management_type GroupManagementType Who is allowed to manage the group.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
created UInt64 The group creation time as a UTC timestamp in milliseconds since the Unix epoch.
group_external_id String? External ID of group. This is an arbitrary ID that an admin can attach to a group. This field is optional.
member_count UInt32? The number of members in the group. This field is optional.
members List of (GroupMemberInfo)? List of group members. This field is optional.
GroupMemberInfo
Profile of group member, and role in group.
profile MemberProfile Profile of group member.
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
access_type GroupAccessType The role that the user has in the group.
GroupAccessType (union)
Role of a user in group. The value will be one of the following datatypes:
member Void User is a member of the group, but has no special permissions.
owner Void User can rename the group, and add/remove members.
Errors
Example: group_not_found
{
    "error_summary": "group_not_found/...",
    "error": {
        ".tag": "group_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: system_managed_group_disallowed
{
    "error_summary": "system_managed_group_disallowed/...",
    "error": {
        ".tag": "system_managed_group_disallowed"
    }
}
Example: group_name_already_used
{
    "error_summary": "group_name_already_used/...",
    "error": {
        ".tag": "group_name_already_used"
    }
}
Example: group_name_invalid
{
    "error_summary": "group_name_invalid/...",
    "error": {
        ".tag": "group_name_invalid"
    }
}
Example: external_id_already_in_use
{
    "error_summary": "external_id_already_in_use/...",
    "error": {
        ".tag": "external_id_already_in_use"
    }
}
GroupUpdateError (union)
The value will be one of the following datatypes:
group_not_found Void No matching group found. No groups match the specified group ID.
system_managed_group_disallowed Void This operation is not supported on system-managed groups.
group_name_already_used Void The requested group name is already being used by another group.
group_name_invalid Void Group name is empty or has invalid characters.
external_id_already_in_use Void The requested external ID is already being used by another group.

/linked_apps/list_member_linked_apps

Version
Description

List all linked applications of the team member.
Note, this endpoint does not list any team-linked applications.

URL Structure
https://api.dropboxapi.com/2/team/linked_apps/list_member_linked_apps
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/linked_apps/list_member_linked_apps \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_member_id\": \"dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I\"}"
Parameters
{
    "team_member_id": "dbmid:AAFdgehTzw7WlXhZJsbGCLePe8RvQGYDr-I"
}
ListMemberAppsArg
team_member_id String The team member id.
Returns
ListMemberAppsResult
linked_api_apps List of (ApiApp) List of third party applications linked by this team member.
ApiApp
Information on linked third party applications.
app_id String The application unique id.
app_name String The application name.
is_app_folder Boolean Whether the linked application uses a dedicated folder.
publisher String? The application publisher name. This field is optional.
publisher_url String? The publisher's URL. This field is optional.
linked Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this application was linked. This field is optional.
Errors
Example: member_not_found
{
    "error_summary": "member_not_found/...",
    "error": {
        ".tag": "member_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ListMemberAppsError (open union)
Error returned by linked_apps/list_member_linked_apps. The value will be one of the following datatypes. New values may be introduced as our API evolves.
member_not_found Void Member not found.

/linked_apps/list_members_linked_apps

Version
Description

List all applications linked to the team members' accounts.
Note, this endpoint does not list any team-linked applications.

URL Structure
https://api.dropboxapi.com/2/team/linked_apps/list_members_linked_apps
Authentication
Team Authentication
Endpoint format
RPC
Parameters
ListMembersAppsArg
Arguments for linked_apps/list_members_linked_apps.
cursor String? At the first call to the linked_apps/list_members_linked_apps the cursor shouldn't be passed. Then, if the result of the call includes a cursor, the following requests should include the received cursors in order to receive the next sub list of the team applications. This field is optional.
Returns
ListMembersAppsResult
Information returned by linked_apps/list_members_linked_apps.
apps List of (MemberLinkedApps) The linked applications of each member of the team.
MemberLinkedApps
Information on linked applications of a team member.
team_member_id String The member unique Id.
linked_api_apps List of (ApiApp) List of third party applications linked by this team member.
ApiApp
Information on linked third party applications.
app_id String The application unique id.
app_name String The application name.
is_app_folder Boolean Whether the linked application uses a dedicated folder.
publisher String? The application publisher name. This field is optional.
publisher_url String? The publisher's URL. This field is optional.
linked Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this application was linked. This field is optional.
has_more Boolean If true, then there are more apps available. Pass the cursor to linked_apps/list_members_linked_apps to retrieve the rest.
cursor String? Pass the cursor into linked_apps/list_members_linked_apps to receive the next sub list of team's applications. This field is optional.
Errors
Example: reset
{
    "error_summary": "reset/...",
    "error": {
        ".tag": "reset"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ListMembersAppsError (open union)
Error returned by linked_apps/list_members_linked_apps. The value will be one of the following datatypes. New values may be introduced as our API evolves.
reset Void Indicates that the cursor has been invalidated. Call linked_apps/list_members_linked_apps again with an empty cursor to obtain a new cursor.

/linked_apps/revoke_linked_app

Version
Description

Revoke a linked application of the team member.

URL Structure
https://api.dropboxapi.com/2/team/linked_apps/revoke_linked_app
Authentication
Team Authentication
Endpoint format
RPC
Parameters
RevokeLinkedApiAppArg
app_id String The application's unique id.
team_member_id String The unique id of the member owning the device.
keep_app_folder Boolean Whether to keep the application dedicated folder (in case the application uses one). The default for this field is True.
Returns

No return values.

Errors
Example: app_not_found
{
    "error_summary": "app_not_found/...",
    "error": {
        ".tag": "app_not_found"
    }
}
Example: member_not_found
{
    "error_summary": "member_not_found/...",
    "error": {
        ".tag": "member_not_found"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
RevokeLinkedAppError (open union)
Error returned by linked_apps/revoke_linked_app. The value will be one of the following datatypes. New values may be introduced as our API evolves.
app_not_found Void Application not found.
member_not_found Void Member not found.

/linked_apps/revoke_linked_app_batch

Version
Description

Revoke a list of linked applications of the team members.

URL Structure
https://api.dropboxapi.com/2/team/linked_apps/revoke_linked_app_batch
Authentication
Team Authentication
Endpoint format
RPC
Parameters
RevokeLinkedApiAppBatchArg
revoke_linked_app List of (RevokeLinkedApiAppArg)
RevokeLinkedApiAppArg
app_id String The application's unique id.
team_member_id String The unique id of the member owning the device.
keep_app_folder Boolean Whether to keep the application dedicated folder (in case the application uses one). The default for this field is True.
Returns
RevokeLinkedAppBatchResult
revoke_linked_app_status List of (RevokeLinkedAppStatus)
RevokeLinkedAppStatus
success Boolean Result of the revoking request.
error_type RevokeLinkedAppError? The error cause in case of a failure. This field is optional.
RevokeLinkedAppError (open union)
Error returned by linked_apps/revoke_linked_app. The value will be one of the following datatypes. New values may be introduced as our API evolves.
app_not_found Void Application not found.
member_not_found Void Member not found.
Errors
RevokeLinkedAppBatchError (open union)
Error returned by linked_apps/revoke_linked_app_batch. The value will be one of the following datatypes. New values may be introduced as our API evolves.

/member_space_limits/excluded_users/add

Version
Description

Add users to member space limits excluded users list.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/add
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/add \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"users\": [{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}]}"
Parameters
{
    "users": [
        {
            ".tag": "team_member_id",
            "team_member_id": "dbmid:efgh5678"
        }
    ]
}
ExcludedUsersUpdateArg
Argument of excluded users update operation. Should include a list of users to add/remove (according to endpoint), Maximum size of the list is 1000 users.
users List of (UserSelectorArg)? List of users to be added/removed. This field is optional.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
{
    "status": {
        ".tag": "success"
    }
}
ExcludedUsersUpdateResult
Excluded users update result.
status ExcludedUsersUpdateStatus Update status.
ExcludedUsersUpdateStatus (open union)
Excluded users update operation status. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success Void Update successful.
Errors
Example: users_not_in_team
{
    "error_summary": "users_not_in_team/...",
    "error": {
        ".tag": "users_not_in_team"
    }
}
Example: too_many_users
{
    "error_summary": "too_many_users/...",
    "error": {
        ".tag": "too_many_users"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ExcludedUsersUpdateError (open union)
Excluded users update error. The value will be one of the following datatypes. New values may be introduced as our API evolves.
users_not_in_team Void At least one of the users is not part of your team.
too_many_users Void A maximum of 1000 users for each of addition/removal can be supplied.

/member_space_limits/excluded_users/list

Version
Description

List member space limits excluded users.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/list
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/list \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"limit\": 100}"
Parameters
{
    "limit": 100
}
ExcludedUsersListArg
Excluded users list argument.
limit UInt32(min=1, max=1000) Number of results to return per call. The default for this field is 1000.
Returns
{
    "users": [],
    "has_more": false,
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
ExcludedUsersListResult
Excluded users list result.
users List of (MemberProfile)
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
has_more Boolean Is true if there are additional excluded users that have not been returned yet. An additional call to member_space_limits/excluded_users/list/continue can retrieve them.
cursor String? Pass the cursor into member_space_limits/excluded_users/list/continue to obtain additional excluded users. This field is optional.
Errors
Example: list_error
{
    "error_summary": "list_error/...",
    "error": {
        ".tag": "list_error"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ExcludedUsersListError (open union)
Excluded users list error. The value will be one of the following datatypes. New values may be introduced as our API evolves.
list_error Void An error occurred.

/member_space_limits/excluded_users/list/continue

Version
Description

Continue listing member space limits excluded users.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/list/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/list/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
ExcludedUsersListContinueArg
Excluded users list continue argument.
cursor String Indicates from what point to get the next set of users.
Returns
{
    "users": [],
    "has_more": false,
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
ExcludedUsersListResult
Excluded users list result.
users List of (MemberProfile)
MemberProfile
Basic member profile.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
has_more Boolean Is true if there are additional excluded users that have not been returned yet. An additional call to member_space_limits/excluded_users/list/continue can retrieve them.
cursor String? Pass the cursor into member_space_limits/excluded_users/list/continue to obtain additional excluded users. This field is optional.
Errors
Example: invalid_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ExcludedUsersListContinueError (open union)
Excluded users list continue error. The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_cursor Void The cursor is invalid.

/member_space_limits/excluded_users/remove

Version
Description

Remove users from member space limits excluded users list.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/remove
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/excluded_users/remove \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"users\": [{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}]}"
Parameters
{
    "users": [
        {
            ".tag": "team_member_id",
            "team_member_id": "dbmid:efgh5678"
        }
    ]
}
ExcludedUsersUpdateArg
Argument of excluded users update operation. Should include a list of users to add/remove (according to endpoint), Maximum size of the list is 1000 users.
users List of (UserSelectorArg)? List of users to be added/removed. This field is optional.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
{
    "status": {
        ".tag": "success"
    }
}
ExcludedUsersUpdateResult
Excluded users update result.
status ExcludedUsersUpdateStatus Update status.
ExcludedUsersUpdateStatus (open union)
Excluded users update operation status. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success Void Update successful.
Errors
Example: users_not_in_team
{
    "error_summary": "users_not_in_team/...",
    "error": {
        ".tag": "users_not_in_team"
    }
}
Example: too_many_users
{
    "error_summary": "too_many_users/...",
    "error": {
        ".tag": "too_many_users"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
ExcludedUsersUpdateError (open union)
Excluded users update error. The value will be one of the following datatypes. New values may be introduced as our API evolves.
users_not_in_team Void At least one of the users is not part of your team.
too_many_users Void A maximum of 1000 users for each of addition/removal can be supplied.

/member_space_limits/get_custom_quota

Version
Description

Get users custom quota. Returns none as the custom quota if none was set. A maximum of 1000 members can be specified in a single call.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/get_custom_quota
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/get_custom_quota \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"users\": [{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}]}"
Parameters
{
    "users": [
        {
            ".tag": "team_member_id",
            "team_member_id": "dbmid:efgh5678"
        }
    ]
}
CustomQuotaUsersArg
users List of (UserSelectorArg) List of users.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
CustomQuotaResult (open union)
User custom quota. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success UserCustomQuotaResult User's custom quota.
UserCustomQuotaResult
User and their custom quota in GB (1 TB = 1024 GB). No quota returns if the user has no custom quota set.
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
quota_gb UInt32(min=15)? This field is optional.
invalid_user UserSelectorArg Invalid user (not in team).
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Errors
Example: too_many_users
{
    "error_summary": "too_many_users/...",
    "error": {
        ".tag": "too_many_users"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
CustomQuotaError (open union)
Error returned when getting member custom quota. The value will be one of the following datatypes. New values may be introduced as our API evolves.
too_many_users Void A maximum of 1000 users can be set for a single call.

/member_space_limits/remove_custom_quota

Version
Description

Remove users custom quota. A maximum of 1000 members can be specified in a single call.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/remove_custom_quota
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/remove_custom_quota \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"users\": [{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}]}"
Parameters
{
    "users": [
        {
            ".tag": "team_member_id",
            "team_member_id": "dbmid:efgh5678"
        }
    ]
}
CustomQuotaUsersArg
users List of (UserSelectorArg) List of users.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
RemoveCustomQuotaResult (open union)
User result for setting member custom quota. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success UserSelectorArg Successfully removed user.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
invalid_user UserSelectorArg Invalid user (not in team).
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Errors
Example: too_many_users
{
    "error_summary": "too_many_users/...",
    "error": {
        ".tag": "too_many_users"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
CustomQuotaError (open union)
Error returned when getting member custom quota. The value will be one of the following datatypes. New values may be introduced as our API evolves.
too_many_users Void A maximum of 1000 users can be set for a single call.

/member_space_limits/set_custom_quota

Version
Description

Set users custom quota. Custom quota has to be at least 15GB. A maximum of 1000 members can be specified in a single call.

URL Structure
https://api.dropboxapi.com/2/team/member_space_limits/set_custom_quota
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/member_space_limits/set_custom_quota \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"users_and_quotas\": [{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"quota_gb\": 30}]}"
Parameters
{
    "users_and_quotas": [
        {
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "quota_gb": 30
        }
    ]
}
SetCustomQuotaArg
users_and_quotas List of (UserCustomQuotaArg) List of users and their custom quotas.
UserCustomQuotaArg
User and their required custom quota in GB (1 TB = 1024 GB).
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
quota_gb UInt32(min=15)
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
CustomQuotaResult (open union)
User custom quota. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success UserCustomQuotaResult User's custom quota.
UserCustomQuotaResult
User and their custom quota in GB (1 TB = 1024 GB). No quota returns if the user has no custom quota set.
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
quota_gb UInt32(min=15)? This field is optional.
invalid_user UserSelectorArg Invalid user (not in team).
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Errors
Example: too_many_users
{
    "error_summary": "too_many_users/...",
    "error": {
        ".tag": "too_many_users"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: some_users_are_excluded
{
    "error_summary": "some_users_are_excluded/...",
    "error": {
        ".tag": "some_users_are_excluded"
    }
}
SetCustomQuotaError (union)
Error returned when setting member custom quota. The value will be one of the following datatypes:
too_many_users Void A maximum of 1000 users can be set for a single call.
some_users_are_excluded Void Some of the users are on the excluded users list and can't have custom quota set.

/members/add

Version
Description

Adds members to a team.
Permission : Team member management
A maximum of 20 members can be specified in a single call.
If no Dropbox account exists with the email address specified, a new Dropbox account will be created with the given email address, and that account will be invited to the team.
If a personal Dropbox account exists with the email address specified in the call, this call will create a placeholder Dropbox account for the user on the team and send an email inviting the user to migrate their existing personal account onto the team.
Team member management apps are required to set an initial given_name and surname for a user to use in the team invitation and for 'Perform as team member' actions taken on the user before they become 'active'.

URL Structure
https://api.dropboxapi.com/2/team/members/add
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/add \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"new_members\": [{\"member_email\": \"tom.s@company.com\",\"member_given_name\": \"Tom\",\"member_surname\": \"Silverstone\",\"member_external_id\": \"company_id:342432\",\"send_welcome_email\": true,\"role\": \"member_only\"}],\"force_async\": false}"
Parameters
{
    "new_members": [
        {
            "member_email": "tom.s@company.com",
            "member_given_name": "Tom",
            "member_surname": "Silverstone",
            "member_external_id": "company_id:342432",
            "send_welcome_email": true,
            "role": "member_only"
        }
    ],
    "force_async": false
}
MembersAddArg
new_members List of (MemberAddArg) Details of new members to be added to the team.
MemberAddArg
member_email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
member_given_name String(max_length=100, pattern="[^/:?*<>"|]*")? Member's first name. This field is optional.
member_surname String(max_length=100, pattern="[^/:?*<>"|]*")? Member's last name. This field is optional.
member_external_id String(max_length=64)? External ID for member. This field is optional.
member_persistent_id String? Persistent ID for member. This field is only available to teams using persistent ID SAML configuration. This field is optional.
send_welcome_email Boolean Whether to send a welcome email to the member. If send_welcome_email is false, no email invitation will be sent to the user. This may be useful for apps using single sign-on (SSO) flows for onboarding that want to handle announcements themselves. The default for this field is True.
role AdminTier The default for this union is member_only.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
is_directory_restricted Boolean? Whether a user is directory restricted. This field is optional.
force_async Boolean Whether to force the add to happen asynchronously. The default for this field is False.
Returns
{
    ".tag": "complete",
    "complete": [
        {
            ".tag": "success",
            "profile": {
                "team_member_id": "dbmid:FDFSVF-DFSDF",
                "email": "tami@seagull.com",
                "email_verified": false,
                "status": {
                    ".tag": "active"
                },
                "name": {
                    "given_name": "Franz",
                    "surname": "Ferdinand",
                    "familiar_name": "Franz",
                    "display_name": "Franz Ferdinand (Personal)",
                    "abbreviated_name": "FF"
                },
                "membership_type": {
                    ".tag": "full"
                },
                "groups": [
                    "g:e2db7665347abcd600000000001a2b3c"
                ],
                "member_folder_id": "20",
                "external_id": "244423",
                "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "secondary_emails": [
                    {
                        "email": "grape@strawberry.com",
                        "is_verified": false
                    },
                    {
                        "email": "apple@orange.com",
                        "is_verified": true
                    }
                ],
                "joined_on": "2015-05-12T15:50:38Z",
                "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
            },
            "role": {
                ".tag": "member_only"
            }
        }
    ]
}
MembersAddLaunch (union)
The value will be one of the following datatypes:
async_job_id String(min_length=1) This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete List of (MemberAddResult)
MemberAddResult (union)
Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed. The value will be one of the following datatypes:
success TeamMemberInfo Describes a user that was successfully added to the team.
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
team_license_limit String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Team is already full. The organization has no available licenses.
free_team_member_limit_reached String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Team is already full. The free team member limit has been reached.
user_already_on_team String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.
user_on_another_team String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.
user_already_paired String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User is already paired.
user_migration_failed String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User migration has failed.
duplicate_external_member_id String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") A user with the given external member ID already exists on the team (including in recoverable state).
duplicate_member_persistent_id String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") A user with the given persistent ID already exists on the team (including in recoverable state).
persistent_id_disabled String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
user_creation_failed String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User creation has failed.
Errors

No errors.

/members/add/job_status/get

Version
Description

Once an async_job_id is returned from members/add , use this to poll the status of the asynchronous request.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/add/job_status/get
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/add/job_status/get \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"async_job_id\": \"34g93hh34h04y384084\"}"
Parameters
{
    "async_job_id": "34g93hh34h04y384084"
}
PollArg
Arguments for methods that poll the status of an asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace.
async_job_id String(min_length=1) Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Returns
{
    ".tag": "complete",
    "complete": [
        {
            ".tag": "success",
            "profile": {
                "team_member_id": "dbmid:FDFSVF-DFSDF",
                "email": "tami@seagull.com",
                "email_verified": false,
                "status": {
                    ".tag": "active"
                },
                "name": {
                    "given_name": "Franz",
                    "surname": "Ferdinand",
                    "familiar_name": "Franz",
                    "display_name": "Franz Ferdinand (Personal)",
                    "abbreviated_name": "FF"
                },
                "membership_type": {
                    ".tag": "full"
                },
                "groups": [
                    "g:e2db7665347abcd600000000001a2b3c"
                ],
                "member_folder_id": "20",
                "external_id": "244423",
                "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "secondary_emails": [
                    {
                        "email": "grape@strawberry.com",
                        "is_verified": false
                    },
                    {
                        "email": "apple@orange.com",
                        "is_verified": true
                    }
                ],
                "joined_on": "2015-05-12T15:50:38Z",
                "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
            },
            "role": {
                ".tag": "member_only"
            }
        }
    ]
}
Example: in_progress
{
    ".tag": "in_progress"
}
MembersAddJobStatus (union)
The value will be one of the following datatypes:
in_progress Void The asynchronous job is still in progress.
complete List of (MemberAddResult) The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to members/add, a corresponding item is returned in this list.
MemberAddResult (union)
Describes the result of attempting to add a single user to the team. 'success' is the only value indicating that a user was indeed added to the team - the other values explain the type of failure that occurred, and include the email of the user for which the operation has failed. The value will be one of the following datatypes:
success TeamMemberInfo Describes a user that was successfully added to the team.
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
team_license_limit String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Team is already full. The organization has no available licenses.
free_team_member_limit_reached String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Team is already full. The free team member limit has been reached.
user_already_on_team String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User is already on this team. The provided email address is associated with a user who is already a member of (including in recoverable state) or invited to the team.
user_on_another_team String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User is already on another team. The provided email address is associated with a user that is already a member or invited to another team.
user_already_paired String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User is already paired.
user_migration_failed String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User migration has failed.
duplicate_external_member_id String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") A user with the given external member ID already exists on the team (including in recoverable state).
duplicate_member_persistent_id String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") A user with the given persistent ID already exists on the team (including in recoverable state).
persistent_id_disabled String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
user_creation_failed String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User creation has failed.
failed String The asynchronous job returned an error. The string contains an error message.
Errors
Example: invalid_async_job_id
{
    "error_summary": "invalid_async_job_id/...",
    "error": {
        ".tag": "invalid_async_job_id"
    }
}
Example: internal_error
{
    "error_summary": "internal_error/...",
    "error": {
        ".tag": "internal_error"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
PollError (open union)
Error returned by methods for polling the status of asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_async_job_id Void The job ID is invalid.
internal_error Void Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

/members/delete_profile_photo

Version
Description

Deletes a team member's profile photo.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/delete_profile_photo
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/delete_profile_photo \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    }
}
MembersDeleteProfilePhotoArg
user UserSelectorArg Identity of the user whose profile photo will be deleted.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
{
    "profile": {
        "team_member_id": "dbmid:FDFSVF-DFSDF",
        "email": "tami@seagull.com",
        "email_verified": false,
        "status": {
            ".tag": "active"
        },
        "name": {
            "given_name": "Franz",
            "surname": "Ferdinand",
            "familiar_name": "Franz",
            "display_name": "Franz Ferdinand (Personal)",
            "abbreviated_name": "FF"
        },
        "membership_type": {
            ".tag": "full"
        },
        "groups": [
            "g:e2db7665347abcd600000000001a2b3c"
        ],
        "member_folder_id": "20",
        "external_id": "244423",
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "secondary_emails": [
            {
                "email": "grape@strawberry.com",
                "is_verified": false
            },
            {
                "email": "apple@orange.com",
                "is_verified": true
            }
        ],
        "joined_on": "2015-05-12T15:50:38Z",
        "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
    },
    "role": {
        ".tag": "member_only"
    }
}
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: set_profile_disallowed
{
    "error_summary": "set_profile_disallowed/...",
    "error": {
        ".tag": "set_profile_disallowed"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersDeleteProfilePhotoError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
set_profile_disallowed Void Modifying deleted users is not allowed.

/members/get_info

Version
Description

Returns information about multiple team members.
Permission : Team information
This endpoint will return MembersGetInfoItem.id_not_found, for IDs (or emails) that cannot be matched to a valid team member.

URL Structure
https://api.dropboxapi.com/2/team/members/get_info
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/get_info \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"members\": [{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}]}"
Parameters
{
    "members": [
        {
            ".tag": "team_member_id",
            "team_member_id": "dbmid:efgh5678"
        }
    ]
}
MembersGetInfoArgs
members List of (UserSelectorArg) List of team members.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
MembersGetInfoItem (union)
Describes a result obtained for a single user whose id was specified in the parameter of members/get_info. The value will be one of the following datatypes:
id_not_found String An ID that was provided as a parameter to members/get_info, and did not match a corresponding user. This might be a team_member_id, an email, or an external ID, depending on how the method was called.
member_info TeamMemberInfo Info about a team member.
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
Errors
MembersGetInfoError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.

/members/list

Version
Description

Lists members of a team.
Permission : Team information.

URL Structure
https://api.dropboxapi.com/2/team/members/list
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/list \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"limit\": 100,\"include_removed\": false}"
Parameters
{
    "limit": 100,
    "include_removed": false
}
MembersListArg
limit UInt32(min=1, max=1000) Number of results to return per call. The default for this field is 1000.
include_removed Boolean Whether to return removed members. The default for this field is False.
Returns
{
    "members": [
        {
            "profile": {
                "team_member_id": "dbmid:FDFSVF-DFSDF",
                "email": "tami@seagull.com",
                "email_verified": false,
                "status": {
                    ".tag": "active"
                },
                "name": {
                    "given_name": "Franz",
                    "surname": "Ferdinand",
                    "familiar_name": "Franz",
                    "display_name": "Franz Ferdinand (Personal)",
                    "abbreviated_name": "FF"
                },
                "membership_type": {
                    ".tag": "full"
                },
                "groups": [
                    "g:e2db7665347abcd600000000001a2b3c"
                ],
                "member_folder_id": "20",
                "external_id": "244423",
                "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "secondary_emails": [
                    {
                        "email": "grape@strawberry.com",
                        "is_verified": false
                    },
                    {
                        "email": "apple@orange.com",
                        "is_verified": true
                    }
                ],
                "joined_on": "2015-05-12T15:50:38Z",
                "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
            },
            "role": {
                ".tag": "member_only"
            }
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": true
}
MembersListResult
members List of (TeamMemberInfo) List of team members.
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
cursor String Pass the cursor into members/list/continue to obtain the additional members.
has_more Boolean Is true if there are additional team members that have not been returned yet. An additional call to members/list/continue can retrieve them.
Errors
MembersListError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.

/members/list/continue

Version
Description

Once a cursor has been retrieved from members/list, use this to paginate through all team members.
Permission : Team information.

URL Structure
https://api.dropboxapi.com/2/team/members/list/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/list/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
MembersListContinueArg
cursor String Indicates from what point to get the next set of members.
Returns
{
    "members": [
        {
            "profile": {
                "team_member_id": "dbmid:FDFSVF-DFSDF",
                "email": "tami@seagull.com",
                "email_verified": false,
                "status": {
                    ".tag": "active"
                },
                "name": {
                    "given_name": "Franz",
                    "surname": "Ferdinand",
                    "familiar_name": "Franz",
                    "display_name": "Franz Ferdinand (Personal)",
                    "abbreviated_name": "FF"
                },
                "membership_type": {
                    ".tag": "full"
                },
                "groups": [
                    "g:e2db7665347abcd600000000001a2b3c"
                ],
                "member_folder_id": "20",
                "external_id": "244423",
                "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
                "secondary_emails": [
                    {
                        "email": "grape@strawberry.com",
                        "is_verified": false
                    },
                    {
                        "email": "apple@orange.com",
                        "is_verified": true
                    }
                ],
                "joined_on": "2015-05-12T15:50:38Z",
                "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
            },
            "role": {
                ".tag": "member_only"
            }
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": true
}
MembersListResult
members List of (TeamMemberInfo) List of team members.
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
cursor String Pass the cursor into members/list/continue to obtain the additional members.
has_more Boolean Is true if there are additional team members that have not been returned yet. An additional call to members/list/continue can retrieve them.
Errors
Example: invalid_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersListContinueError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_cursor Void The cursor is invalid.

/members/move_former_member_files

Version
Description

Moves removed member's files to a different member. This endpoint initiates an asynchronous job. To obtain the final result of the job, the client should periodically poll members/move_former_member_files/job_status/check.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/move_former_member_files
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/move_former_member_files \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"transfer_dest_id\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"transfer_admin_id\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "transfer_dest_id": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "transfer_admin_id": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    }
}
MembersDataTransferArg
user UserSelectorArg Identity of user to remove/suspend/have their files moved.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
transfer_dest_id UserSelectorArg Files from the deleted member account will be transferred to this user.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
transfer_admin_id UserSelectorArg Errors during the transfer process will be sent via email to this user.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns
Example: complete
{
    ".tag": "complete"
}
Example: async_job_id
{
    ".tag": "async_job_id",
    "async_job_id": "34g93hh34h04y384084"
}
LaunchEmptyResult (union)
Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes:
async_job_id String(min_length=1) This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete Void The job finished synchronously and successfully.
Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: removed_and_transfer_dest_should_differ
{
    "error_summary": "removed_and_transfer_dest_should_differ/...",
    "error": {
        ".tag": "removed_and_transfer_dest_should_differ"
    }
}
Example: removed_and_transfer_admin_should_differ
{
    "error_summary": "removed_and_transfer_admin_should_differ/...",
    "error": {
        ".tag": "removed_and_transfer_admin_should_differ"
    }
}
Example: transfer_dest_user_not_found
{
    "error_summary": "transfer_dest_user_not_found/...",
    "error": {
        ".tag": "transfer_dest_user_not_found"
    }
}
Example: transfer_dest_user_not_in_team
{
    "error_summary": "transfer_dest_user_not_in_team/...",
    "error": {
        ".tag": "transfer_dest_user_not_in_team"
    }
}
Example: transfer_admin_user_not_in_team
{
    "error_summary": "transfer_admin_user_not_in_team/...",
    "error": {
        ".tag": "transfer_admin_user_not_in_team"
    }
}
Example: transfer_admin_user_not_found
{
    "error_summary": "transfer_admin_user_not_found/...",
    "error": {
        ".tag": "transfer_admin_user_not_found"
    }
}
Example: unspecified_transfer_admin_id
{
    "error_summary": "unspecified_transfer_admin_id/...",
    "error": {
        ".tag": "unspecified_transfer_admin_id"
    }
}
Example: transfer_admin_is_not_admin
{
    "error_summary": "transfer_admin_is_not_admin/...",
    "error": {
        ".tag": "transfer_admin_is_not_admin"
    }
}
Example: recipient_not_verified
{
    "error_summary": "recipient_not_verified/...",
    "error": {
        ".tag": "recipient_not_verified"
    }
}
Example: user_data_is_being_transferred
{
    "error_summary": "user_data_is_being_transferred/...",
    "error": {
        ".tag": "user_data_is_being_transferred"
    }
}
Example: user_not_removed
{
    "error_summary": "user_not_removed/...",
    "error": {
        ".tag": "user_not_removed"
    }
}
Example: user_data_cannot_be_transferred
{
    "error_summary": "user_data_cannot_be_transferred/...",
    "error": {
        ".tag": "user_data_cannot_be_transferred"
    }
}
Example: user_data_already_transferred
{
    "error_summary": "user_data_already_transferred/...",
    "error": {
        ".tag": "user_data_already_transferred"
    }
}
MembersTransferFormerMembersFilesError (union)
The value will be one of the following datatypes:
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
removed_and_transfer_dest_should_differ Void Expected removed user and transfer_dest user to be different.
removed_and_transfer_admin_should_differ Void Expected removed user and transfer_admin user to be different.
transfer_dest_user_not_found Void No matching user found for the argument transfer_dest_id.
transfer_dest_user_not_in_team Void The provided transfer_dest_id does not exist on this team.
transfer_admin_user_not_in_team Void The provided transfer_admin_id does not exist on this team.
transfer_admin_user_not_found Void No matching user found for the argument transfer_admin_id.
unspecified_transfer_admin_id Void The transfer_admin_id argument must be provided when file transfer is requested.
transfer_admin_is_not_admin Void Specified transfer_admin user is not a team admin.
recipient_not_verified Void The recipient user's email is not verified.
user_data_is_being_transferred Void The user's data is being transferred. Please wait some time before retrying.
user_not_removed Void No matching removed user found for the argument user.
user_data_cannot_be_transferred Void User files aren't transferable anymore.
user_data_already_transferred Void User's data has already been transferred to another user.

/members/move_former_member_files/job_status/check

Version
Description

Once an async_job_id is returned from members/move_former_member_files , use this to poll the status of the asynchronous request.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/move_former_member_files/job_status/check
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/move_former_member_files/job_status/check \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"async_job_id\": \"34g93hh34h04y384084\"}"
Parameters
{
    "async_job_id": "34g93hh34h04y384084"
}
PollArg
Arguments for methods that poll the status of an asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace.
async_job_id String(min_length=1) Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Returns
Example: complete
{
    ".tag": "complete"
}
Example: in_progress
{
    ".tag": "in_progress"
}
PollEmptyResult (union)
Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes:
in_progress Void The asynchronous job is still in progress.
complete Void The asynchronous job has completed successfully.
Errors
Example: invalid_async_job_id
{
    "error_summary": "invalid_async_job_id/...",
    "error": {
        ".tag": "invalid_async_job_id"
    }
}
Example: internal_error
{
    "error_summary": "internal_error/...",
    "error": {
        ".tag": "internal_error"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
PollError (open union)
Error returned by methods for polling the status of asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_async_job_id Void The job ID is invalid.
internal_error Void Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

/members/recover

Version
Description

Recover a deleted member.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

URL Structure
https://api.dropboxapi.com/2/team/members/recover
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/recover \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    }
}
MembersRecoverArg
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user UserSelectorArg Identity of user to recover.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns

No return values.

Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_unrecoverable
{
    "error_summary": "user_unrecoverable/...",
    "error": {
        ".tag": "user_unrecoverable"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: team_license_limit
{
    "error_summary": "team_license_limit/...",
    "error": {
        ".tag": "team_license_limit"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersRecoverError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_unrecoverable Void The user is not recoverable.
user_not_in_team Void The user is not a member of the team.
team_license_limit Void Team is full. The organization has no available licenses.

/members/remove

Version
Description

Removes a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
Accounts can be recovered via members/recover for a 7 day period or until the account has been permanently deleted or transferred to another account (whichever comes first). Calling members/add while a user is still recoverable on your team will return with MemberAddResult.user_already_on_team.
Accounts can have their files transferred via the admin console for a limited time, based on the version history length associated with the team (120 days for most teams).
This endpoint may initiate an asynchronous job. To obtain the final result of the job, the client should periodically poll members/remove/job_status/get.

URL Structure
https://api.dropboxapi.com/2/team/members/remove
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/remove \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"wipe_data\": true,\"transfer_dest_id\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"transfer_admin_id\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"keep_account\": false,\"retain_team_shares\": false}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "wipe_data": true,
    "transfer_dest_id": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "transfer_admin_id": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "keep_account": false,
    "retain_team_shares": false
}
MembersRemoveArg
user UserSelectorArg Identity of user to remove/suspend/have their files moved.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
wipe_data Boolean If provided, controls if the user's data will be deleted on their linked devices. The default for this field is True.
transfer_dest_id UserSelectorArg? If provided, files from the deleted member account will be transferred to this user. This field is optional.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
transfer_admin_id UserSelectorArg? If provided, errors during the transfer process will be sent via email to this user. If the transfer_dest_id argument was provided, then this argument must be provided as well. This field is optional.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
keep_account Boolean Downgrade the member to a Basic account. The user will retain the email address associated with their Dropbox account and data in their account that is not restricted to team members. In order to keep the account the argument wipe_data should be set to false. The default for this field is False.
retain_team_shares Boolean If provided, allows removed users to keep access to folders already explicitly shared with them (not via a group) when they are downgraded to a Basic account. Users will not retain access to folders that do not allow external sharing. In order to keep the sharing relationships, the arguments wipe_data should be set to false and keep_account should be set to true. The default for this field is False.
Returns
Example: complete
{
    ".tag": "complete"
}
Example: async_job_id
{
    ".tag": "async_job_id",
    "async_job_id": "34g93hh34h04y384084"
}
LaunchEmptyResult (union)
Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes:
async_job_id String(min_length=1) This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete Void The job finished synchronously and successfully.
Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: removed_and_transfer_dest_should_differ
{
    "error_summary": "removed_and_transfer_dest_should_differ/...",
    "error": {
        ".tag": "removed_and_transfer_dest_should_differ"
    }
}
Example: removed_and_transfer_admin_should_differ
{
    "error_summary": "removed_and_transfer_admin_should_differ/...",
    "error": {
        ".tag": "removed_and_transfer_admin_should_differ"
    }
}
Example: transfer_dest_user_not_found
{
    "error_summary": "transfer_dest_user_not_found/...",
    "error": {
        ".tag": "transfer_dest_user_not_found"
    }
}
Example: transfer_dest_user_not_in_team
{
    "error_summary": "transfer_dest_user_not_in_team/...",
    "error": {
        ".tag": "transfer_dest_user_not_in_team"
    }
}
Example: transfer_admin_user_not_in_team
{
    "error_summary": "transfer_admin_user_not_in_team/...",
    "error": {
        ".tag": "transfer_admin_user_not_in_team"
    }
}
Example: transfer_admin_user_not_found
{
    "error_summary": "transfer_admin_user_not_found/...",
    "error": {
        ".tag": "transfer_admin_user_not_found"
    }
}
Example: unspecified_transfer_admin_id
{
    "error_summary": "unspecified_transfer_admin_id/...",
    "error": {
        ".tag": "unspecified_transfer_admin_id"
    }
}
Example: transfer_admin_is_not_admin
{
    "error_summary": "transfer_admin_is_not_admin/...",
    "error": {
        ".tag": "transfer_admin_is_not_admin"
    }
}
Example: recipient_not_verified
{
    "error_summary": "recipient_not_verified/...",
    "error": {
        ".tag": "recipient_not_verified"
    }
}
Example: remove_last_admin
{
    "error_summary": "remove_last_admin/...",
    "error": {
        ".tag": "remove_last_admin"
    }
}
Example: cannot_keep_account_and_transfer
{
    "error_summary": "cannot_keep_account_and_transfer/...",
    "error": {
        ".tag": "cannot_keep_account_and_transfer"
    }
}
Example: cannot_keep_account_and_delete_data
{
    "error_summary": "cannot_keep_account_and_delete_data/...",
    "error": {
        ".tag": "cannot_keep_account_and_delete_data"
    }
}
Example: email_address_too_long_to_be_disabled
{
    "error_summary": "email_address_too_long_to_be_disabled/...",
    "error": {
        ".tag": "email_address_too_long_to_be_disabled"
    }
}
Example: cannot_keep_invited_user_account
{
    "error_summary": "cannot_keep_invited_user_account/...",
    "error": {
        ".tag": "cannot_keep_invited_user_account"
    }
}
Example: cannot_retain_shares_when_data_wiped
{
    "error_summary": "cannot_retain_shares_when_data_wiped/...",
    "error": {
        ".tag": "cannot_retain_shares_when_data_wiped"
    }
}
Example: cannot_retain_shares_when_no_account_kept
{
    "error_summary": "cannot_retain_shares_when_no_account_kept/...",
    "error": {
        ".tag": "cannot_retain_shares_when_no_account_kept"
    }
}
Example: cannot_retain_shares_when_team_external_sharing_off
{
    "error_summary": "cannot_retain_shares_when_team_external_sharing_off/...",
    "error": {
        ".tag": "cannot_retain_shares_when_team_external_sharing_off"
    }
}
Example: cannot_keep_account
{
    "error_summary": "cannot_keep_account/...",
    "error": {
        ".tag": "cannot_keep_account"
    }
}
Example: cannot_keep_account_under_legal_hold
{
    "error_summary": "cannot_keep_account_under_legal_hold/...",
    "error": {
        ".tag": "cannot_keep_account_under_legal_hold"
    }
}
MembersRemoveError (union)
The value will be one of the following datatypes:
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
removed_and_transfer_dest_should_differ Void Expected removed user and transfer_dest user to be different.
removed_and_transfer_admin_should_differ Void Expected removed user and transfer_admin user to be different.
transfer_dest_user_not_found Void No matching user found for the argument transfer_dest_id.
transfer_dest_user_not_in_team Void The provided transfer_dest_id does not exist on this team.
transfer_admin_user_not_in_team Void The provided transfer_admin_id does not exist on this team.
transfer_admin_user_not_found Void No matching user found for the argument transfer_admin_id.
unspecified_transfer_admin_id Void The transfer_admin_id argument must be provided when file transfer is requested.
transfer_admin_is_not_admin Void Specified transfer_admin user is not a team admin.
recipient_not_verified Void The recipient user's email is not verified.
remove_last_admin Void The user is the last admin of the team, so it cannot be removed from it.
cannot_keep_account_and_transfer Void Cannot keep account and transfer the data to another user at the same time.
cannot_keep_account_and_delete_data Void Cannot keep account and delete the data at the same time. To keep the account the argument wipe_data should be set to false.
email_address_too_long_to_be_disabled Void The email address of the user is too long to be disabled.
cannot_keep_invited_user_account Void Cannot keep account of an invited user.
cannot_retain_shares_when_data_wiped Void Cannot retain team shares when the user's data is marked for deletion on their linked devices. The argument wipe_data should be set to false.
cannot_retain_shares_when_no_account_kept Void The user's account must be kept in order to retain team shares. The argument keep_account should be set to true.
cannot_retain_shares_when_team_external_sharing_off Void Externally sharing files, folders, and links must be enabled in team settings in order to retain team shares for the user.
cannot_keep_account Void Only a team admin, can convert this account to a Basic account.
cannot_keep_account_under_legal_hold Void This user content is currently being held. To convert this member's account to a Basic account, you'll first need to remove them from the hold.

/members/remove/job_status/get

Version
Description

Once an async_job_id is returned from members/remove , use this to poll the status of the asynchronous request.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/remove/job_status/get
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/remove/job_status/get \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"async_job_id\": \"34g93hh34h04y384084\"}"
Parameters
{
    "async_job_id": "34g93hh34h04y384084"
}
PollArg
Arguments for methods that poll the status of an asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace.
async_job_id String(min_length=1) Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Returns
Example: complete
{
    ".tag": "complete"
}
Example: in_progress
{
    ".tag": "in_progress"
}
PollEmptyResult (union)
Result returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes:
in_progress Void The asynchronous job is still in progress.
complete Void The asynchronous job has completed successfully.
Errors
Example: invalid_async_job_id
{
    "error_summary": "invalid_async_job_id/...",
    "error": {
        ".tag": "invalid_async_job_id"
    }
}
Example: internal_error
{
    "error_summary": "internal_error/...",
    "error": {
        ".tag": "internal_error"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
PollError (open union)
Error returned by methods for polling the status of asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_async_job_id Void The job ID is invalid.
internal_error Void Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

/members/secondary_emails/add

Version
PREVIEW - may change or disappear without notice
Description

Add secondary emails to users.
Permission : Team member management.
Emails that are on verified domains will be verified automatically. For each email address not on a verified domain a verification email will be sent.

URL Structure
https://api.dropboxapi.com/2/team/members/secondary_emails/add
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/secondary_emails/add \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"new_secondary_emails\": [{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"secondary_emails\": [\"bob2@hotmail.com\",\"bob@inst.gov\"]}]}"
Parameters
{
    "new_secondary_emails": [
        {
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "secondary_emails": [
                "bob2@hotmail.com",
                "bob@inst.gov"
            ]
        }
    ]
}
AddSecondaryEmailsArg
new_secondary_emails List of (UserSecondaryEmailsArg) List of users and secondary emails to add.
UserSecondaryEmailsArg
User and a list of secondary emails.
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
secondary_emails List of (String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$"))
Returns
{
    "results": [
        {
            ".tag": "success",
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "results": [
                {
                    ".tag": "success",
                    "success": {
                        "email": "apple@orange.com",
                        "is_verified": true
                    }
                },
                {
                    ".tag": "unavailable",
                    "unavailable": "alice@example.com"
                }
            ]
        },
        {
            ".tag": "invalid_user",
            "invalid_user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            }
        }
    ]
}
AddSecondaryEmailsResult
results List of (UserAddResult) List of users and secondary email results.
UserAddResult (open union)
Result of trying to add secondary emails to a user. 'success' is the only value indicating that a user was successfully retrieved for adding secondary emails. The other values explain the type of error that occurred, and include the user for which the error occured. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success UserSecondaryEmailsResult Describes a user and the results for each attempt to add a secondary email.
UserSecondaryEmailsResult
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
results List of (AddSecondaryEmailResult)
AddSecondaryEmailResult (open union)
Result of trying to add a secondary email to a user. 'success' is the only value indicating that a secondary email was successfully added to a user. The other values explain the type of error that occurred, and include the email for which the error occured. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success SecondaryEmail Describes a secondary email that was successfully added to a user.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
unavailable String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email is not available to be claimed by the user.
already_pending String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email is already a pending email for the user.
already_owned_by_user String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email is already a verified email for the user.
reached_limit String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") User already has the maximum number of secondary emails allowed.
transient_errordeprecated String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Field is deprecated. A transient error occurred. Please try again later.
too_many_updates String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") An error occurred due to conflicting updates. Please try again later.
unknown_error String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") An unknown error occurred.
rate_limited String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Too many emails are being sent to this email address. Please try again later.
invalid_user UserSelectorArg Specified user is not a valid target for adding secondary emails.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
unverified UserSelectorArg Secondary emails can only be added to verified users.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
placeholder_user UserSelectorArg Secondary emails cannot be added to placeholder users.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Errors
Example: secondary_emails_disabled
{
    "error_summary": "secondary_emails_disabled/...",
    "error": {
        ".tag": "secondary_emails_disabled"
    }
}
Example: too_many_emails
{
    "error_summary": "too_many_emails/...",
    "error": {
        ".tag": "too_many_emails"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
AddSecondaryEmailsError (open union)
Error returned when adding secondary emails fails. The value will be one of the following datatypes. New values may be introduced as our API evolves.
secondary_emails_disabled Void Secondary emails are disabled for the team.
too_many_emails Void A maximum of 20 secondary emails can be added in a single call.

/members/secondary_emails/delete

Version
PREVIEW - may change or disappear without notice
Description

Delete secondary emails from users
Permission : Team member management.
Users will be notified of deletions of verified secondary emails at both the secondary email and their primary email.

URL Structure
https://api.dropboxapi.com/2/team/members/secondary_emails/delete
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/secondary_emails/delete \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"emails_to_delete\": [{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"secondary_emails\": [\"bob2@hotmail.com\",\"bob@inst.gov\"]}]}"
Parameters
{
    "emails_to_delete": [
        {
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "secondary_emails": [
                "bob2@hotmail.com",
                "bob@inst.gov"
            ]
        }
    ]
}
DeleteSecondaryEmailsArg
emails_to_delete List of (UserSecondaryEmailsArg) List of users and their secondary emails to delete.
UserSecondaryEmailsArg
User and a list of secondary emails.
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
secondary_emails List of (String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$"))
Returns
{
    "results": [
        {
            ".tag": "success",
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "results": [
                {
                    ".tag": "success",
                    "success": "alice@example.com"
                },
                {
                    ".tag": "not_found",
                    "not_found": "alic@example.com"
                }
            ]
        }
    ]
}
DeleteSecondaryEmailsResult
results List of (UserDeleteResult)
UserDeleteResult (open union)
Result of trying to delete a user's secondary emails. 'success' is the only value indicating that a user was successfully retrieved for deleting secondary emails. The other values explain the type of error that occurred, and include the user for which the error occured. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success UserDeleteEmailsResult Describes a user and the results for each attempt to delete a secondary email.
UserDeleteEmailsResult
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
results List of (DeleteSecondaryEmailResult)
DeleteSecondaryEmailResult (open union)
Result of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email for which the error occured. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") The secondary email was successfully deleted.
not_found String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") The email address was not found for the user.
cannot_remove_primary String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") The email address is the primary email address of the user, and cannot be removed.
invalid_user UserSelectorArg Specified user is not a valid target for deleting secondary emails.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Errors

No errors.

/members/secondary_emails/resend_verification_emails

Version
PREVIEW - may change or disappear without notice
Description

Resend secondary email verification emails.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/secondary_emails/resend_verification_emails
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/secondary_emails/resend_verification_emails \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"emails_to_resend\": [{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"secondary_emails\": [\"bob2@hotmail.com\",\"bob@inst.gov\"]}]}"
Parameters
{
    "emails_to_resend": [
        {
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "secondary_emails": [
                "bob2@hotmail.com",
                "bob@inst.gov"
            ]
        }
    ]
}
ResendVerificationEmailArg
emails_to_resend List of (UserSecondaryEmailsArg) List of users and secondary emails to resend verification emails to.
UserSecondaryEmailsArg
User and a list of secondary emails.
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
secondary_emails List of (String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$"))
Returns
{
    "results": [
        {
            ".tag": "success",
            "user": {
                ".tag": "team_member_id",
                "team_member_id": "dbmid:efgh5678"
            },
            "results": [
                {
                    ".tag": "success",
                    "success": "alice@example.com"
                }
            ]
        }
    ]
}
ResendVerificationEmailResult
List of users and resend results.
results List of (UserResendResult)
UserResendResult (open union)
Result of trying to resend verification emails to a user. 'success' is the only value indicating that a user was successfully retrieved for sending verification emails. The other values explain the type of error that occurred, and include the user for which the error occured. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success UserResendEmailsResult Describes a user and the results for each attempt to resend verification emails.
UserResendEmailsResult
user UserSelectorArg
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
results List of (ResendSecondaryEmailResult)
ResendSecondaryEmailResult (open union)
Result of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. The other values explain the type of error that occurred, and include the email for which the error occured. The value will be one of the following datatypes. New values may be introduced as our API evolves.
success String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") A verification email was successfully sent to the secondary email address.
not_pending String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") This secondary email address is not pending for the user.
rate_limited String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Too many emails are being sent to this email address. Please try again later.
invalid_user UserSelectorArg Specified user is not a valid target for resending verification emails.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Errors

No errors.

/members/send_welcome_email

Version
Description

Sends welcome email to pending team member.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
No-op if team member is not pending.

URL Structure
https://api.dropboxapi.com/2/team/members/send_welcome_email
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/send_welcome_email \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}"
Parameters
{
    ".tag": "team_member_id",
    "team_member_id": "dbmid:efgh5678"
}
Example: email
{
    ".tag": "email",
    "email": "dan@hotmail.com"
}
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns

No return values.

Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersSendWelcomeError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.

/members/set_admin_permissions

Version
Description

Updates a team member's permissions.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/set_admin_permissions
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/set_admin_permissions \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"new_role\": \"member_only\"}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "new_role": "member_only"
}
MembersSetPermissionsArg
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user UserSelectorArg Identity of user whose role will be set.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
new_role AdminTier The new role of the member.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
Returns
{
    "team_member_id": "dbmid:9978889",
    "role": {
        ".tag": "member_only"
    }
}
MembersSetPermissionsResult
team_member_id String The member ID of the user to which the change was applied.
role AdminTier The role after the change.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: last_admin
{
    "error_summary": "last_admin/...",
    "error": {
        ".tag": "last_admin"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: cannot_set_permissions
{
    "error_summary": "cannot_set_permissions/...",
    "error": {
        ".tag": "cannot_set_permissions"
    }
}
Example: team_license_limit
{
    "error_summary": "team_license_limit/...",
    "error": {
        ".tag": "team_license_limit"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersSetPermissionsError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
last_admin Void Cannot remove the admin setting of the last admin.
user_not_in_team Void The user is not a member of the team.
cannot_set_permissions Void Cannot remove/grant permissions.
team_license_limit Void Team is full. The organization has no available licenses.

/members/set_profile

Version
Description

Updates a team member's profile.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/set_profile
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/set_profile \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"new_email\": \"t.smith@domain.com\",\"new_surname\": \"Smith\"}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "new_email": "t.smith@domain.com",
    "new_surname": "Smith"
}
MembersSetProfileArg
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
At least one of new_email, new_external_id, new_given_name, and/or new_surname must be provided.
user UserSelectorArg Identity of user whose profile will be set.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
new_email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")? New email for member. This field is optional.
new_external_id String(max_length=64)? New external ID for member. This field is optional.
new_given_name String(max_length=100, pattern="[^/:?*<>"|]*")? New given name for member. This field is optional.
new_surname String(max_length=100, pattern="[^/:?*<>"|]*")? New surname for member. This field is optional.
new_persistent_id String? New persistent ID. This field only available to teams using persistent ID SAML configuration. This field is optional.
new_is_directory_restricted Boolean? New value for whether the user is a directory restricted user. This field is optional.
Returns
{
    "profile": {
        "team_member_id": "dbmid:FDFSVF-DFSDF",
        "email": "tami@seagull.com",
        "email_verified": false,
        "status": {
            ".tag": "active"
        },
        "name": {
            "given_name": "Franz",
            "surname": "Ferdinand",
            "familiar_name": "Franz",
            "display_name": "Franz Ferdinand (Personal)",
            "abbreviated_name": "FF"
        },
        "membership_type": {
            ".tag": "full"
        },
        "groups": [
            "g:e2db7665347abcd600000000001a2b3c"
        ],
        "member_folder_id": "20",
        "external_id": "244423",
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "secondary_emails": [
            {
                "email": "grape@strawberry.com",
                "is_verified": false
            },
            {
                "email": "apple@orange.com",
                "is_verified": true
            }
        ],
        "joined_on": "2015-05-12T15:50:38Z",
        "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
    },
    "role": {
        ".tag": "member_only"
    }
}
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: external_id_and_new_external_id_unsafe
{
    "error_summary": "external_id_and_new_external_id_unsafe/...",
    "error": {
        ".tag": "external_id_and_new_external_id_unsafe"
    }
}
Example: no_new_data_specified
{
    "error_summary": "no_new_data_specified/...",
    "error": {
        ".tag": "no_new_data_specified"
    }
}
Example: email_reserved_for_other_user
{
    "error_summary": "email_reserved_for_other_user/...",
    "error": {
        ".tag": "email_reserved_for_other_user"
    }
}
Example: external_id_used_by_other_user
{
    "error_summary": "external_id_used_by_other_user/...",
    "error": {
        ".tag": "external_id_used_by_other_user"
    }
}
Example: set_profile_disallowed
{
    "error_summary": "set_profile_disallowed/...",
    "error": {
        ".tag": "set_profile_disallowed"
    }
}
Example: param_cannot_be_empty
{
    "error_summary": "param_cannot_be_empty/...",
    "error": {
        ".tag": "param_cannot_be_empty"
    }
}
Example: persistent_id_disabled
{
    "error_summary": "persistent_id_disabled/...",
    "error": {
        ".tag": "persistent_id_disabled"
    }
}
Example: persistent_id_used_by_other_user
{
    "error_summary": "persistent_id_used_by_other_user/...",
    "error": {
        ".tag": "persistent_id_used_by_other_user"
    }
}
Example: directory_restricted_off
{
    "error_summary": "directory_restricted_off/...",
    "error": {
        ".tag": "directory_restricted_off"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersSetProfileError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
external_id_and_new_external_id_unsafe Void It is unsafe to use both external_id and new_external_id.
no_new_data_specified Void None of new_email, new_given_name, new_surname, or new_external_id are specified.
email_reserved_for_other_user Void Email is already reserved for another user.
external_id_used_by_other_user Void The external ID is already in use by another team member.
set_profile_disallowed Void Modifying deleted users is not allowed.
param_cannot_be_empty Void Parameter new_email cannot be empty.
persistent_id_disabled Void Persistent ID is only available to teams with persistent ID SAML configuration. Please contact Dropbox for more information.
persistent_id_used_by_other_user Void The persistent ID is already in use by another team member.
directory_restricted_off Void Directory Restrictions option is not available.

/members/set_profile_photo

Version
Description

Updates a team member's profile photo.
Permission : Team member management.

URL Structure
https://api.dropboxapi.com/2/team/members/set_profile_photo
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/set_profile_photo \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"photo\": {\".tag\": \"base64_data\",\"base64_data\": \"SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4=\"}}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "photo": {
        ".tag": "base64_data",
        "base64_data": "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4="
    }
}
MembersSetProfilePhotoArg
user UserSelectorArg Identity of the user whose profile photo will be set.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
photo PhotoSourceArg Image to set as the member's new profile photo.
PhotoSourceArg (open union)
This datatype comes from an imported namespace originally defined in the account namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
base64_data String Image data in base64-encoded bytes.
Returns
{
    "profile": {
        "team_member_id": "dbmid:FDFSVF-DFSDF",
        "email": "tami@seagull.com",
        "email_verified": false,
        "status": {
            ".tag": "active"
        },
        "name": {
            "given_name": "Franz",
            "surname": "Ferdinand",
            "familiar_name": "Franz",
            "display_name": "Franz Ferdinand (Personal)",
            "abbreviated_name": "FF"
        },
        "membership_type": {
            ".tag": "full"
        },
        "groups": [
            "g:e2db7665347abcd600000000001a2b3c"
        ],
        "member_folder_id": "20",
        "external_id": "244423",
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "secondary_emails": [
            {
                "email": "grape@strawberry.com",
                "is_verified": false
            },
            {
                "email": "apple@orange.com",
                "is_verified": true
            }
        ],
        "joined_on": "2015-05-12T15:50:38Z",
        "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
    },
    "role": {
        ".tag": "member_only"
    }
}
TeamMemberInfo
Information about a team member.
profile TeamMemberProfile Profile of a user as a member of a team.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
role AdminTier The user's role in the team.
AdminTier (union)
Describes which team-related admin permissions a user has. The value will be one of the following datatypes:
team_admin Void User is an administrator of the team - has all permissions.
user_management_admin Void User can do most user provisioning, de-provisioning and management.
support_admin Void User can do a limited set of common support tasks for existing users.
member_only Void User is not an admin of the team.
Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: set_profile_disallowed
{
    "error_summary": "set_profile_disallowed/...",
    "error": {
        ".tag": "set_profile_disallowed"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersSetProfilePhotoError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
set_profile_disallowed Void Modifying deleted users is not allowed.
photo_error SetProfilePhotoError
SetProfilePhotoError (open union)
This datatype comes from an imported namespace originally defined in the account namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
file_type_error Void File cannot be set as profile photo.
file_size_error Void File cannot exceed 10 MB.
dimension_error Void Image must be larger than 128 x 128.
thumbnail_error Void Image could not be thumbnailed.
transient_error Void Temporary infrastructure failure, please retry.

/members/suspend

Version
Description

Suspend a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

URL Structure
https://api.dropboxapi.com/2/team/members/suspend
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/suspend \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"},\"wipe_data\": false}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    },
    "wipe_data": false
}
MembersDeactivateArg
user UserSelectorArg Identity of user to remove/suspend/have their files moved.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
wipe_data Boolean If provided, controls if the user's data will be deleted on their linked devices. The default for this field is True.
Returns

No return values.

Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: suspend_inactive_user
{
    "error_summary": "suspend_inactive_user/...",
    "error": {
        ".tag": "suspend_inactive_user"
    }
}
Example: suspend_last_admin
{
    "error_summary": "suspend_last_admin/...",
    "error": {
        ".tag": "suspend_last_admin"
    }
}
Example: team_license_limit
{
    "error_summary": "team_license_limit/...",
    "error": {
        ".tag": "team_license_limit"
    }
}
MembersSuspendError (union)
The value will be one of the following datatypes:
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
suspend_inactive_user Void The user is not active, so it cannot be suspended.
suspend_last_admin Void The user is the last admin of the team, so it cannot be suspended.
team_license_limit Void Team is full. The organization has no available licenses.

/members/unsuspend

Version
Description

Unsuspend a member from a team.
Permission : Team member management
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.

URL Structure
https://api.dropboxapi.com/2/team/members/unsuspend
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/members/unsuspend \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"user\": {\".tag\": \"team_member_id\",\"team_member_id\": \"dbmid:efgh5678\"}}"
Parameters
{
    "user": {
        ".tag": "team_member_id",
        "team_member_id": "dbmid:efgh5678"
    }
}
MembersUnsuspendArg
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user UserSelectorArg Identity of user to unsuspend.
UserSelectorArg (union)
Argument for selecting a single user, either by team_member_id, external_id or email. The value will be one of the following datatypes:
team_member_id String
external_id String(max_length=64)
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$")
Returns

No return values.

Errors
Example: user_not_found
{
    "error_summary": "user_not_found/...",
    "error": {
        ".tag": "user_not_found"
    }
}
Example: user_not_in_team
{
    "error_summary": "user_not_in_team/...",
    "error": {
        ".tag": "user_not_in_team"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: unsuspend_non_suspended_member
{
    "error_summary": "unsuspend_non_suspended_member/...",
    "error": {
        ".tag": "unsuspend_non_suspended_member"
    }
}
Example: team_license_limit
{
    "error_summary": "team_license_limit/...",
    "error": {
        ".tag": "team_license_limit"
    }
}
MembersUnsuspendError (union)
The value will be one of the following datatypes:
user_not_found Void No matching user found. The provided team_member_id, email, or external_id does not exist on this team.
user_not_in_team Void The user is not a member of the team.
unsuspend_non_suspended_member Void The user is unsuspended, so it cannot be unsuspended again.
team_license_limit Void Team is full. The organization has no available licenses.

/namespaces/list

Version
Description

Returns a list of all team-accessible namespaces. This list includes team folders, shared folders containing team members, team members' home namespaces, and team members' app folders. Home namespaces and app folders are always owned by this team or members of the team, but shared folders may be owned by other users or other teams. Duplicates may occur in the list.

URL Structure
https://api.dropboxapi.com/2/team/namespaces/list
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/namespaces/list \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"limit\": 1}"
Parameters
{
    "limit": 1
}
TeamNamespacesListArg
limitdeprecated UInt32(min=1, max=1000) Field is deprecated. Specifying a value here has no effect. The default for this field is 1000.
Returns
{
    "namespaces": [
        {
            "name": "Marketing",
            "namespace_id": "123456789",
            "namespace_type": {
                ".tag": "shared_folder"
            }
        },
        {
            "name": "Franz Ferdinand",
            "namespace_id": "123456789",
            "namespace_type": {
                ".tag": "team_member_folder"
            },
            "team_member_id": "dbmid:1234567"
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
TeamNamespacesListResult
Result for namespaces/list.
namespaces List of (NamespaceMetadata) List of all namespaces the team can access.
NamespaceMetadata
Properties of a namespace.
name String The name of this namespace.
namespace_id String(pattern="[-_0-9a-zA-Z:]+") The ID of this namespace.
namespace_type NamespaceType The type of this namespace.
NamespaceType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
app_folder Void App sandbox folder.
shared_folder Void Shared folder.
team_folder Void Top-level team-owned folder.
team_member_folder Void Team member's home folder.
team_member_id String? If this is a team member or app folder, the ID of the owning team member. Otherwise, this field is not present. This field is optional.
cursor String Pass the cursor into namespaces/list/continue to obtain additional namespaces. Note that duplicate namespaces may be returned.
has_more Boolean Is true if there are additional namespaces that have not been returned yet.
Errors
Example: invalid_arg
{
    "error_summary": "invalid_arg/...",
    "error": {
        ".tag": "invalid_arg"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TeamNamespacesListError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_arg Void Argument passed in is invalid.

/namespaces/list/continue

Version
Description

Once a cursor has been retrieved from namespaces/list, use this to paginate through all team-accessible namespaces. Duplicates may occur in the list.

URL Structure
https://api.dropboxapi.com/2/team/namespaces/list/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/namespaces/list/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
TeamNamespacesListContinueArg
cursor String Indicates from what point to get the next set of team-accessible namespaces.
Returns
{
    "namespaces": [
        {
            "name": "Marketing",
            "namespace_id": "123456789",
            "namespace_type": {
                ".tag": "shared_folder"
            }
        },
        {
            "name": "Franz Ferdinand",
            "namespace_id": "123456789",
            "namespace_type": {
                ".tag": "team_member_folder"
            },
            "team_member_id": "dbmid:1234567"
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
TeamNamespacesListResult
Result for namespaces/list.
namespaces List of (NamespaceMetadata) List of all namespaces the team can access.
NamespaceMetadata
Properties of a namespace.
name String The name of this namespace.
namespace_id String(pattern="[-_0-9a-zA-Z:]+") The ID of this namespace.
namespace_type NamespaceType The type of this namespace.
NamespaceType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
app_folder Void App sandbox folder.
shared_folder Void Shared folder.
team_folder Void Top-level team-owned folder.
team_member_folder Void Team member's home folder.
team_member_id String? If this is a team member or app folder, the ID of the owning team member. Otherwise, this field is not present. This field is optional.
cursor String Pass the cursor into namespaces/list/continue to obtain additional namespaces. Note that duplicate namespaces may be returned.
has_more Boolean Is true if there are additional namespaces that have not been returned yet.
Errors
Example: invalid_arg
{
    "error_summary": "invalid_arg/...",
    "error": {
        ".tag": "invalid_arg"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: invalid_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
TeamNamespacesListContinueError (union)
The value will be one of the following datatypes:
invalid_arg Void Argument passed in is invalid.
invalid_cursor Void The cursor is invalid.

/reports/get_activity

Version
Description

Retrieves reporting data about a team's user activity.

URL Structure
https://api.dropboxapi.com/2/team/reports/get_activity
Authentication
Team Authentication
Endpoint format
RPC
Parameters
DateRange
Input arguments that can be provided for most reports.
start_date Timestamp(format="%Y-%m-%d")? Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. This field is optional.
end_date Timestamp(format="%Y-%m-%d")? Optional ending date (exclusive). This field is optional.
Returns
GetActivityReport
Activity Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
start_date String First date present in the results as 'YYYY-MM-DD' or None.
adds List of (UInt64?) Array of total number of adds by team members. This field is optional.
edits List of (UInt64?) Array of number of edits by team members. If the same user edits the same file multiple times this is counted as a single edit. This field is optional.
deletes List of (UInt64?) Array of total number of deletes by team members. This field is optional.
active_users_28_day List of (UInt64?) Array of the number of users who have been active in the last 28 days. This field is optional.
active_users_7_day List of (UInt64?) Array of the number of users who have been active in the last week. This field is optional.
active_users_1_day List of (UInt64?) Array of the number of users who have been active in the last day. This field is optional.
active_shared_folders_28_day List of (UInt64?) Array of the number of shared folders with some activity in the last 28 days. This field is optional.
active_shared_folders_7_day List of (UInt64?) Array of the number of shared folders with some activity in the last week. This field is optional.
active_shared_folders_1_day List of (UInt64?) Array of the number of shared folders with some activity in the last day. This field is optional.
shared_links_created List of (UInt64?) Array of the number of shared links created. This field is optional.
shared_links_viewed_by_team List of (UInt64?) Array of the number of views by team users to shared links created by the team. This field is optional.
shared_links_viewed_by_outside_user List of (UInt64?) Array of the number of views by users outside of the team to shared links created by the team. This field is optional.
shared_links_viewed_by_not_logged_in List of (UInt64?) Array of the number of views by non-logged-in users to shared links created by the team. This field is optional.
shared_links_viewed_total List of (UInt64?) Array of the total number of views to shared links created by the team. This field is optional.
Errors
DateRangeError (open union)
Errors that can originate from problems in input arguments to reports. The value will be one of the following datatypes. New values may be introduced as our API evolves.

/reports/get_devices

Version
Description

Retrieves reporting data about a team's linked devices.

URL Structure
https://api.dropboxapi.com/2/team/reports/get_devices
Authentication
Team Authentication
Endpoint format
RPC
Parameters
DateRange
Input arguments that can be provided for most reports.
start_date Timestamp(format="%Y-%m-%d")? Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. This field is optional.
end_date Timestamp(format="%Y-%m-%d")? Optional ending date (exclusive). This field is optional.
Returns
GetDevicesReport
Devices Report Result. Contains subsections for different time ranges of activity. Each of the items in each subsection of the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
start_date String First date present in the results as 'YYYY-MM-DD' or None.
active_1_day DevicesActive Report of the number of devices active in the last day.
DevicesActive
Each of the items is an array of values, one value per day. The value is the number of devices active within a time window, ending with that day.
If there is no data for a day, then the value will be None.
windows List of (UInt64?) Array of number of linked windows (desktop) clients with activity. This field is optional.
macos List of (UInt64?) Array of number of linked mac (desktop) clients with activity. This field is optional.
linux List of (UInt64?) Array of number of linked linus (desktop) clients with activity. This field is optional.
ios List of (UInt64?) Array of number of linked ios devices with activity. This field is optional.
android List of (UInt64?) Array of number of linked android devices with activity. This field is optional.
other List of (UInt64?) Array of number of other linked devices (blackberry, windows phone, etc) with activity. This field is optional.
total List of (UInt64?) Array of total number of linked clients with activity. This field is optional.
active_7_day DevicesActive Report of the number of devices active in the last 7 days.
DevicesActive
Each of the items is an array of values, one value per day. The value is the number of devices active within a time window, ending with that day.
If there is no data for a day, then the value will be None.
windows List of (UInt64?) Array of number of linked windows (desktop) clients with activity. This field is optional.
macos List of (UInt64?) Array of number of linked mac (desktop) clients with activity. This field is optional.
linux List of (UInt64?) Array of number of linked linus (desktop) clients with activity. This field is optional.
ios List of (UInt64?) Array of number of linked ios devices with activity. This field is optional.
android List of (UInt64?) Array of number of linked android devices with activity. This field is optional.
other List of (UInt64?) Array of number of other linked devices (blackberry, windows phone, etc) with activity. This field is optional.
total List of (UInt64?) Array of total number of linked clients with activity. This field is optional.
active_28_day DevicesActive Report of the number of devices active in the last 28 days.
DevicesActive
Each of the items is an array of values, one value per day. The value is the number of devices active within a time window, ending with that day.
If there is no data for a day, then the value will be None.
windows List of (UInt64?) Array of number of linked windows (desktop) clients with activity. This field is optional.
macos List of (UInt64?) Array of number of linked mac (desktop) clients with activity. This field is optional.
linux List of (UInt64?) Array of number of linked linus (desktop) clients with activity. This field is optional.
ios List of (UInt64?) Array of number of linked ios devices with activity. This field is optional.
android List of (UInt64?) Array of number of linked android devices with activity. This field is optional.
other List of (UInt64?) Array of number of other linked devices (blackberry, windows phone, etc) with activity. This field is optional.
total List of (UInt64?) Array of total number of linked clients with activity. This field is optional.
Errors
DateRangeError (open union)
Errors that can originate from problems in input arguments to reports. The value will be one of the following datatypes. New values may be introduced as our API evolves.

/reports/get_membership

Version
Description

Retrieves reporting data about a team's membership.

URL Structure
https://api.dropboxapi.com/2/team/reports/get_membership
Authentication
Team Authentication
Endpoint format
RPC
Parameters
DateRange
Input arguments that can be provided for most reports.
start_date Timestamp(format="%Y-%m-%d")? Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. This field is optional.
end_date Timestamp(format="%Y-%m-%d")? Optional ending date (exclusive). This field is optional.
Returns
GetMembershipReport
Membership Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
start_date String First date present in the results as 'YYYY-MM-DD' or None.
team_size List of (UInt64?) Team size, for each day. This field is optional.
pending_invites List of (UInt64?) The number of pending invites to the team, for each day. This field is optional.
members_joined List of (UInt64?) The number of members that joined the team, for each day. This field is optional.
suspended_members List of (UInt64?) The number of suspended team members, for each day. This field is optional.
licenses List of (UInt64?) The total number of licenses the team has, for each day. This field is optional.
Errors
DateRangeError (open union)
Errors that can originate from problems in input arguments to reports. The value will be one of the following datatypes. New values may be introduced as our API evolves.

/reports/get_storage

Version
Description

Retrieves reporting data about a team's storage usage.

URL Structure
https://api.dropboxapi.com/2/team/reports/get_storage
Authentication
Team Authentication
Endpoint format
RPC
Parameters
DateRange
Input arguments that can be provided for most reports.
start_date Timestamp(format="%Y-%m-%d")? Optional starting date (inclusive). If start_date is None or too long ago, this field will be set to 6 months ago. This field is optional.
end_date Timestamp(format="%Y-%m-%d")? Optional ending date (exclusive). This field is optional.
Returns
GetStorageReport
Storage Report Result. Each of the items in the storage report is an array of values, one value per day. If there is no data for a day, then the value will be None.
start_date String First date present in the results as 'YYYY-MM-DD' or None.
total_usage List of (UInt64?) Sum of the shared, unshared, and datastore usages, for each day. This field is optional.
shared_usage List of (UInt64?) Array of the combined size (bytes) of team members' shared folders, for each day. This field is optional.
unshared_usage List of (UInt64?) Array of the combined size (bytes) of team members' root namespaces, for each day. This field is optional.
shared_folders List of (UInt64?) Array of the number of shared folders owned by team members, for each day. This field is optional.
member_storage_map List of (List of (StorageBucket)) Array of storage summaries of team members' account sizes. Each storage summary is an array of key, value pairs, where each pair describes a storage bucket. The key indicates the upper bound of the bucket and the value is the number of users in that bucket. There is one such summary per day. If there is no data for a day, the storage summary will be empty.
StorageBucket
Describes the number of users in a specific storage bucket.
bucket String The name of the storage bucket. For example, '1G' is a bucket of users with storage size up to 1 Giga.
users UInt64 The number of people whose storage is in the range of this storage bucket.
Errors
DateRangeError (open union)
Errors that can originate from problems in input arguments to reports. The value will be one of the following datatypes. New values may be introduced as our API evolves.

/team_folder/activate

Version
Description

Sets an archived team folder's status to active.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/activate
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/activate \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_folder_id\": \"123456789\"}"
Parameters
{
    "team_folder_id": "123456789"
}
TeamFolderIdArg
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
Returns
{
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false,
    "sync_setting": {
        ".tag": "default"
    },
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": {
                ".tag": "default"
            }
        }
    ]
}
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
Errors
TeamFolderActivateError (union)
The value will be one of the following datatypes:
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.
status_error TeamFolderInvalidStatusError
TeamFolderInvalidStatusError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The folder is active and the operation did not succeed.
archived Void The folder is archived and the operation did not succeed.
archive_in_progress Void The folder is being archived and the operation did not succeed.
team_shared_dropbox_error TeamFolderTeamSharedDropboxError
TeamFolderTeamSharedDropboxError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disallowed Void This action is not allowed for a shared team root.

/team_folder/archive

Version
Description

Sets an active team folder's status to archived and removes all folder and file members.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/archive
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/archive \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_folder_id\": \"123456789\",\"force_async_off\": false}"
Parameters
{
    "team_folder_id": "123456789",
    "force_async_off": false
}
TeamFolderArchiveArg
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
force_async_off Boolean Whether to force the archive to happen synchronously. The default for this field is False.
Returns
{
    ".tag": "complete",
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false,
    "sync_setting": {
        ".tag": "default"
    },
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": {
                ".tag": "default"
            }
        }
    ]
}
Example: async_job_id
{
    ".tag": "async_job_id",
    "async_job_id": "34g93hh34h04y384084"
}
TeamFolderArchiveLaunch (union)
The value will be one of the following datatypes:
async_job_id String(min_length=1) This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
complete TeamFolderMetadata
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
Errors
TeamFolderArchiveError (union)
The value will be one of the following datatypes:
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.
status_error TeamFolderInvalidStatusError
TeamFolderInvalidStatusError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The folder is active and the operation did not succeed.
archived Void The folder is archived and the operation did not succeed.
archive_in_progress Void The folder is being archived and the operation did not succeed.
team_shared_dropbox_error TeamFolderTeamSharedDropboxError
TeamFolderTeamSharedDropboxError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disallowed Void This action is not allowed for a shared team root.

/team_folder/archive/check

Version
Description

Returns the status of an asynchronous job for archiving a team folder.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/archive/check
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/archive/check \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"async_job_id\": \"34g93hh34h04y384084\"}"
Parameters
{
    "async_job_id": "34g93hh34h04y384084"
}
PollArg
Arguments for methods that poll the status of an asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace.
async_job_id String(min_length=1) Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
Returns
{
    ".tag": "complete",
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false,
    "sync_setting": {
        ".tag": "default"
    },
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": {
                ".tag": "default"
            }
        }
    ]
}
Example: in_progress
{
    ".tag": "in_progress"
}
TeamFolderArchiveJobStatus (union)
The value will be one of the following datatypes:
in_progress Void The asynchronous job is still in progress.
complete TeamFolderMetadata The archive job has finished. The value is the metadata for the resulting team folder.
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
failed TeamFolderArchiveError Error occurred while performing an asynchronous job from team_folder/archive.
TeamFolderArchiveError (union)
The value will be one of the following datatypes:
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.
status_error TeamFolderInvalidStatusError
TeamFolderInvalidStatusError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The folder is active and the operation did not succeed.
archived Void The folder is archived and the operation did not succeed.
archive_in_progress Void The folder is being archived and the operation did not succeed.
team_shared_dropbox_error TeamFolderTeamSharedDropboxError
TeamFolderTeamSharedDropboxError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disallowed Void This action is not allowed for a shared team root.
Errors
Example: invalid_async_job_id
{
    "error_summary": "invalid_async_job_id/...",
    "error": {
        ".tag": "invalid_async_job_id"
    }
}
Example: internal_error
{
    "error_summary": "internal_error/...",
    "error": {
        ".tag": "internal_error"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
PollError (open union)
Error returned by methods for polling the status of asynchronous job. This datatype comes from an imported namespace originally defined in the async namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_async_job_id Void The job ID is invalid.
internal_error Void Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

/team_folder/create

Version
Description

Creates a new, active, team folder with no members.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/create
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/create \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"name\": \"Marketing\",\"sync_setting\": \"not_synced\"}"
Parameters
{
    "name": "Marketing",
    "sync_setting": "not_synced"
}
TeamFolderCreateArg
name String Name for the new team folder.
sync_setting SyncSettingArg? The sync setting to apply to this team folder. Only permitted if the team has team selective sync enabled. This field is optional.
SyncSettingArg (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
Returns
{
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false,
    "sync_setting": {
        ".tag": "default"
    },
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": {
                ".tag": "default"
            }
        }
    ]
}
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
Errors
Example: invalid_folder_name
{
    "error_summary": "invalid_folder_name/...",
    "error": {
        ".tag": "invalid_folder_name"
    }
}
Example: folder_name_already_used
{
    "error_summary": "folder_name_already_used/...",
    "error": {
        ".tag": "folder_name_already_used"
    }
}
Example: folder_name_reserved
{
    "error_summary": "folder_name_reserved/...",
    "error": {
        ".tag": "folder_name_reserved"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TeamFolderCreateError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_folder_name Void The provided name cannot be used.
folder_name_already_used Void There is already a team folder with the provided name.
folder_name_reserved Void The provided name cannot be used because it is reserved.
sync_settings_error SyncSettingsError An error occurred setting the sync settings.
SyncSettingsError (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
path LookupError
LookupError (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
malformed_path String? The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information. This field is optional.
not_found Void There is nothing at the given path.
not_file Void We were expecting a file, but the given path refers to something that isn't a file.
not_folder Void We were expecting a folder, but the given path refers to something that isn't a folder.
restricted_content Void The file cannot be transferred because the content is restricted. For example, sometimes there are legal restrictions due to copyright claims.
unsupported_content_type Void This operation is not supported for this content type.
unsupported_combination Void Setting this combination of sync settings simultaneously is not supported.
unsupported_configuration Void The specified configuration is not supported.

/team_folder/get_info

Version
Description

Retrieves metadata for team folders.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/get_info
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/get_info \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_folder_ids\": [\"947182\",\"5819424\",\"852307532\"]}"
Parameters
{
    "team_folder_ids": [
        "947182",
        "5819424",
        "852307532"
    ]
}
TeamFolderIdListArg
team_folder_ids List of (String(pattern="[-_0-9a-zA-Z:]+"), min_items=1) The list of team folder IDs.
Returns
This route returns a list. This means the route can accept a homogenous list of the following types:
TeamFolderGetInfoItem (union)
The value will be one of the following datatypes:
id_not_found String An ID that was provided as a parameter to team_folder/get_info did not match any of the team's team folders.
team_folder_metadata TeamFolderMetadata Properties of a team folder.
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
Errors

No errors.

/team_folder/list

Version
Description

Lists all team folders.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/list
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/list \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"limit\": 100}"
Parameters
{
    "limit": 100
}
TeamFolderListArg
limit UInt32(min=1, max=1000) The maximum number of results to return per request. The default for this field is 1000.
Returns
{
    "team_folders": [
        {
            "team_folder_id": "123456789",
            "name": "Marketing",
            "status": {
                ".tag": "active"
            },
            "is_team_shared_dropbox": false,
            "sync_setting": {
                ".tag": "default"
            },
            "content_sync_settings": [
                {
                    "id": "id:a4ayc_80_OEAAAAAAAAAXw",
                    "sync_setting": {
                        ".tag": "default"
                    }
                }
            ]
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
TeamFolderListResult
Result for team_folder/list and team_folder/list/continue.
team_folders List of (TeamFolderMetadata) List of all team folders in the authenticated team.
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
cursor String Pass the cursor into team_folder/list/continue to obtain additional team folders.
has_more Boolean Is true if there are additional team folders that have not been returned yet. An additional call to team_folder/list/continue can retrieve them.
Errors
TeamFolderListError
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.

/team_folder/list/continue

Version
Description

Once a cursor has been retrieved from team_folder/list, use this to paginate through all team folders.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/list/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/list/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
TeamFolderListContinueArg
cursor String Indicates from what point to get the next set of team folders.
Returns
{
    "team_folders": [
        {
            "team_folder_id": "123456789",
            "name": "Marketing",
            "status": {
                ".tag": "active"
            },
            "is_team_shared_dropbox": false,
            "sync_setting": {
                ".tag": "default"
            },
            "content_sync_settings": [
                {
                    "id": "id:a4ayc_80_OEAAAAAAAAAXw",
                    "sync_setting": {
                        ".tag": "default"
                    }
                }
            ]
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
TeamFolderListResult
Result for team_folder/list and team_folder/list/continue.
team_folders List of (TeamFolderMetadata) List of all team folders in the authenticated team.
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
cursor String Pass the cursor into team_folder/list/continue to obtain additional team folders.
has_more Boolean Is true if there are additional team folders that have not been returned yet. An additional call to team_folder/list/continue can retrieve them.
Errors
Example: invalid_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TeamFolderListContinueError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_cursor Void The cursor is invalid.

/team_folder/permanently_delete

Version
Description

Permanently deletes an archived team folder.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/permanently_delete
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/permanently_delete \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_folder_id\": \"123456789\"}"
Parameters
{
    "team_folder_id": "123456789"
}
TeamFolderIdArg
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
Returns

No return values.

Errors
TeamFolderPermanentlyDeleteError (union)
The value will be one of the following datatypes:
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.
status_error TeamFolderInvalidStatusError
TeamFolderInvalidStatusError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The folder is active and the operation did not succeed.
archived Void The folder is archived and the operation did not succeed.
archive_in_progress Void The folder is being archived and the operation did not succeed.
team_shared_dropbox_error TeamFolderTeamSharedDropboxError
TeamFolderTeamSharedDropboxError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disallowed Void This action is not allowed for a shared team root.

/team_folder/rename

Version
Description

Changes an active team folder's name.
Permission : Team member file access.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/rename
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/rename \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_folder_id\": \"123456789\",\"name\": \"Sales\"}"
Parameters
{
    "team_folder_id": "123456789",
    "name": "Sales"
}
TeamFolderRenameArg
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String New team folder name.
Returns
{
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false,
    "sync_setting": {
        ".tag": "default"
    },
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": {
                ".tag": "default"
            }
        }
    ]
}
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
Errors
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
Example: invalid_folder_name
{
    "error_summary": "invalid_folder_name/...",
    "error": {
        ".tag": "invalid_folder_name"
    }
}
Example: folder_name_already_used
{
    "error_summary": "folder_name_already_used/...",
    "error": {
        ".tag": "folder_name_already_used"
    }
}
Example: folder_name_reserved
{
    "error_summary": "folder_name_reserved/...",
    "error": {
        ".tag": "folder_name_reserved"
    }
}
TeamFolderRenameError (union)
The value will be one of the following datatypes:
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.
status_error TeamFolderInvalidStatusError
TeamFolderInvalidStatusError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The folder is active and the operation did not succeed.
archived Void The folder is archived and the operation did not succeed.
archive_in_progress Void The folder is being archived and the operation did not succeed.
team_shared_dropbox_error TeamFolderTeamSharedDropboxError
TeamFolderTeamSharedDropboxError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disallowed Void This action is not allowed for a shared team root.
invalid_folder_name Void The provided folder name cannot be used.
folder_name_already_used Void There is already a team folder with the same name.
folder_name_reserved Void The provided name cannot be used because it is reserved.

/team_folder/update_sync_settings

Version
Description

Updates the sync settings on a team folder or its contents. Use of this endpoint requires that the team has team selective sync enabled.

URL Structure
https://api.dropboxapi.com/2/team/team_folder/update_sync_settings
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/team_folder/update_sync_settings \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"team_folder_id\": \"123456789\",\"sync_setting\": \"not_synced\",\"content_sync_settings\": [{\"id\": \"id:a4ayc_80_OEAAAAAAAAAXw\",\"sync_setting\": \"not_synced\"}]}"
Parameters
{
    "team_folder_id": "123456789",
    "sync_setting": "not_synced",
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": "not_synced"
        }
    ]
}
TeamFolderUpdateSyncSettingsArg
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
sync_setting SyncSettingArg? Sync setting to apply to the team folder itself. Only meaningful if the team folder is not a shared team root. This field is optional.
SyncSettingArg (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
content_sync_settings List of (ContentSyncSettingArg)? Sync settings to apply to contents of this team folder. This field is optional.
ContentSyncSettingArg
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSettingArg Setting for this item.
SyncSettingArg (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
Returns
{
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false,
    "sync_setting": {
        ".tag": "default"
    },
    "content_sync_settings": [
        {
            "id": "id:a4ayc_80_OEAAAAAAAAAXw",
            "sync_setting": {
                ".tag": "default"
            }
        }
    ]
}
TeamFolderMetadata
Properties of a team folder.
team_folder_id String(pattern="[-_0-9a-zA-Z:]+") The ID of the team folder.
name String The name of the team folder.
status TeamFolderStatus The status of the team folder.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The team folder and sub-folders are available to all members.
archived Void The team folder is not accessible outside of the team folder manager.
archive_in_progress Void The team folder is not accessible outside of the team folder manager.
is_team_shared_dropbox Boolean True if this team folder is a shared team root.
sync_setting SyncSetting The sync setting applied to this team folder.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
content_sync_settings List of (ContentSyncSetting) Sync settings applied to contents of this team folder.
ContentSyncSetting
This datatype comes from an imported namespace originally defined in the files namespace.
id String(min_length=4, pattern="id:.+") Id of the item this setting is applied to.
sync_setting SyncSetting Setting for this item.
SyncSetting (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
default Void On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.
not_synced Void On first sync to members' computers, the specified folder will be set to not sync with selective sync.
not_synced_inactive Void The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.
Errors
TeamFolderUpdateSyncSettingsError (union)
The value will be one of the following datatypes:
access_error TeamFolderAccessError
TeamFolderAccessError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
invalid_team_folder_id Void The team folder ID is invalid.
no_access Void The authenticated app does not have permission to manage that team folder.
status_error TeamFolderInvalidStatusError
TeamFolderInvalidStatusError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
active Void The folder is active and the operation did not succeed.
archived Void The folder is archived and the operation did not succeed.
archive_in_progress Void The folder is being archived and the operation did not succeed.
team_shared_dropbox_error TeamFolderTeamSharedDropboxError
TeamFolderTeamSharedDropboxError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disallowed Void This action is not allowed for a shared team root.
sync_settings_error SyncSettingsError An error occurred setting the sync settings.
SyncSettingsError (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
path LookupError
LookupError (open union)
This datatype comes from an imported namespace originally defined in the files namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
malformed_path String? The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information. This field is optional.
not_found Void There is nothing at the given path.
not_file Void We were expecting a file, but the given path refers to something that isn't a file.
not_folder Void We were expecting a folder, but the given path refers to something that isn't a folder.
restricted_content Void The file cannot be transferred because the content is restricted. For example, sometimes there are legal restrictions due to copyright claims.
unsupported_content_type Void This operation is not supported for this content type.
unsupported_combination Void Setting this combination of sync settings simultaneously is not supported.
unsupported_configuration Void The specified configuration is not supported.

/token/get_authenticated_admin

Version
Description

Returns the member profile of the admin who generated the team access token used to make the call.

URL Structure
https://api.dropboxapi.com/2/team/token/get_authenticated_admin
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/token/get_authenticated_admin \
    --header "Authorization: Bearer "
Parameters

No parameters.

Returns
{
    "admin_profile": {
        "team_member_id": "dbmid:FDFSVF-DFSDF",
        "email": "tami@seagull.com",
        "email_verified": false,
        "status": {
            ".tag": "active"
        },
        "name": {
            "given_name": "Franz",
            "surname": "Ferdinand",
            "familiar_name": "Franz",
            "display_name": "Franz Ferdinand (Personal)",
            "abbreviated_name": "FF"
        },
        "membership_type": {
            ".tag": "full"
        },
        "groups": [
            "g:e2db7665347abcd600000000001a2b3c"
        ],
        "member_folder_id": "20",
        "external_id": "244423",
        "account_id": "dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc",
        "secondary_emails": [
            {
                "email": "grape@strawberry.com",
                "is_verified": false
            },
            {
                "email": "apple@orange.com",
                "is_verified": true
            }
        ],
        "joined_on": "2015-05-12T15:50:38Z",
        "profile_photo_url": "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102\u0026size=128x128"
    }
}
TokenGetAuthenticatedAdminResult
Results for token/get_authenticated_admin.
admin_profile TeamMemberProfile The admin who authorized the token.
TeamMemberProfile
Profile of a user as a member of a team.
team_member_id String ID of user as a member of a team.
email String Email address of user.
email_verified Boolean Is true if the user's email is verified to be owned by the user.
status TeamMemberStatus The user's status as a member of a specific team.
TeamMemberStatus (union)
The user's status as a member of a specific team. The value will be one of the following datatypes:
active Void User has successfully joined the team.
invited Void User has been invited to a team, but has not joined the team yet.
suspended Void User is no longer a member of the team, but the account can be un-suspended, re-establishing the user as a team member.
removed RemovedStatus User is no longer a member of the team. Removed users are only listed when include_removed is true in members/list.
RemovedStatus
is_recoverable Boolean True if the removed team member is recoverable.
is_disconnected Boolean True if the team member's account was converted to individual account.
name Name Representations for a person's name.
Name
Representations for a person's name to assist with internationalization. This datatype comes from an imported namespace originally defined in the users namespace.
given_name String Also known as a first name.
surname String Also known as a last name or family name.
familiar_name String Locale-dependent name. In the US, a person's familiar name is their given_name, but elsewhere, it could be any combination of a person's given_name and surname.
display_name String A name that can be used directly to represent the name of a user's Dropbox account.
abbreviated_name String An abbreviated form of the person's name. Their initials in most locales.
membership_type TeamMembershipType The user's membership type: full (normal team member) vs limited (does not use a license; no access to the team's shared quota).
TeamMembershipType (union)
The value will be one of the following datatypes:
full Void User uses a license and has full access to team resources like the shared quota.
limiteddeprecated Void Field is deprecated. User does not have access to the shared quota and team admins have restricted administrative control.
groups List of (String) List of group IDs of groups that the user belongs to.
member_folder_id String(pattern="[-_0-9a-zA-Z:]+") The namespace id of the user's root folder.
external_id String? External ID that a team can attach to the user. An application using the API may find it easier to use their own IDs instead of Dropbox IDs like account_id or team_member_id. This field is optional.
account_id String(min_length=40, max_length=40)? A user's account identifier. This field is optional.
secondary_emails List of (SecondaryEmail)? Secondary emails of a user. This field is optional.
SecondaryEmail
This datatype comes from an imported namespace originally defined in the secondary_emails namespace.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$") Secondary email address.
is_verified Boolean Whether or not the secondary email address is verified to be owned by a user.
invited_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was invited to the team (contains value only when the member's status matches TeamMemberStatus.invited). This field is optional.
joined_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user joined as a member of a specific team. This field is optional.
suspended_on Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The date and time the user was suspended from the team (contains value only when the member's status matches TeamMemberStatus.suspended). This field is optional.
persistent_id String? Persistent ID that a team can attach to the user. The persistent ID is unique ID to be used for SAML authentication. This field is optional.
is_directory_restricted Boolean? Whether the user is a directory restricted user. This field is optional.
profile_photo_url String? URL for the photo representing the user, if one is set. This field is optional.
Errors
Example: mapping_not_found
{
    "error_summary": "mapping_not_found/...",
    "error": {
        ".tag": "mapping_not_found"
    }
}
Example: admin_not_active
{
    "error_summary": "admin_not_active/...",
    "error": {
        ".tag": "admin_not_active"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TokenGetAuthenticatedAdminError (open union)
Error returned by token/get_authenticated_admin. The value will be one of the following datatypes. New values may be introduced as our API evolves.
mapping_not_found Void The current token is not associated with a team admin, because mappings were not recorded when the token was created. Consider re-authorizing a new access token to record its authenticating admin.
admin_not_active Void Either the team admin that authorized this token is no longer an active member of the team or no longer a team admin.

team_log

/get_events

Version
Description

Retrieves team events.
Events have a lifespan of two years. Events older than two years will not be returned.
Many attributes note 'may be missing due to historical data gap'.
Note that the file_operations category and & analogous paper events are not available on all Dropbox Business plans. Use features/get_values to check for this feature.
Permission : Team Auditing.

URL Structure
https://api.dropboxapi.com/2/team_log/get_events
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team_log/get_events \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"limit\": 50,\"category\": \"groups\"}"
Parameters
{
    "limit": 50,
    "category": "groups"
}
GetTeamEventsArg
limit UInt32(min=1, max=1000) The maximal number of results to return per call. Note that some calls may not return limit number of events, and may even return no events, even with `has_more` set to true. In this case, callers should fetch again using get_events/continue. The default for this field is 1000.
account_id String(min_length=40, max_length=40)? Filter the events by account ID. Return ony events with this account_id as either Actor, Context, or Participants. This field is optional.
time TimeRange? Filter by time range. This field is optional.
TimeRange
Time range. This datatype comes from an imported namespace originally defined in the team_common namespace.
start_time Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? Optional starting time (inclusive). This field is optional.
end_time Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? Optional ending time (exclusive). This field is optional.
category EventCategory? Filter the returned events to a single category. This field is optional.
EventCategory (open union)
Category of events in event audit log. The value will be one of the following datatypes. New values may be introduced as our API evolves.
apps Void Events that apply to management of linked apps.
comments Void Events that have to do with comments on files and Paper documents.
devices Void Events that apply to linked devices on mobile, desktop and Web platforms.
domains Void Events that involve domain management feature: domain verification, invite enforcement and account capture.
file_operations Void Events that have to do with filesystem operations on files and folders: copy, move, delete, etc.
file_requests Void Events that apply to the file requests feature.
groups Void Events that involve group management.
legal_holds Void Events that involve placing holds on content for litigation reasons
logins Void Events that involve users signing in to or out of Dropbox.
members Void Events that involve team member management.
paper Void Events that apply to Dropbox Paper.
passwords Void Events that involve using, changing or resetting passwords.
reports Void Events that concern generation of admin reports, including team activity and device usage.
sharing Void Events that apply to all types of sharing and collaboration.
showcase Void Events that apply to Dropbox Showcase.
sso Void Events that involve using or configuring single sign-on as well as administrative policies concerning single sign-on.
team_folders Void Events that involve team folder management.
team_policies Void Events that involve a change in team-wide policies.
team_profile Void Events that involve a change in the team profile.
tfa Void Events that involve using or configuring two factor authentication as well as administrative policies concerning two factor authentication.
trusted_teams Void Events that apply to cross-team trust establishment.
Returns
{
    "events": [
        {
            "timestamp": "2017-01-25T15:51:30Z",
            "event_category": {
                ".tag": "tfa"
            },
            "event_type": {
                ".tag": "shared_content_download",
                "description": "(sharing) Downloaded shared file/folder"
            },
            "details": {
                ".tag": "shared_content_download_details",
                "shared_content_link": "abc",
                "shared_content_access_level": {
                    ".tag": "viewer_no_comment"
                },
                "shared_content_owner": {
                    ".tag": "team_member",
                    "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho",
                    "display_name": "John Smith",
                    "email": "john_smith@acmecorp.com",
                    "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q",
                    "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224",
                    "team": {
                        "display_name": "A Team"
                    }
                }
            },
            "actor": {
                ".tag": "user",
                "user": {
                    ".tag": "team_member",
                    "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho",
                    "display_name": "John Smith",
                    "email": "john_smith@acmecorp.com",
                    "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q",
                    "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224",
                    "team": {
                        "display_name": "A Team"
                    }
                }
            },
            "origin": {
                "access_method": {
                    ".tag": "end_user",
                    "end_user": {
                        ".tag": "web",
                        "session_id": "dbwsid:123456789012345678901234567890123456789"
                    }
                },
                "geo_location": {
                    "ip_address": "45.56.78.100",
                    "city": "San Francisco",
                    "region": "California",
                    "country": "US"
                }
            },
            "involve_non_team_member": true,
            "context": {
                ".tag": "team_member",
                "account_id": "dbid:AAHgR8xsQP48a5DQUGPo-Vxsrjd0OByVmho",
                "display_name": "John Smith",
                "email": "john_smith@acmecorp.com",
                "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q",
                "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1224",
                "team": {
                    "display_name": "A Team"
                }
            },
            "participants": [
                {
                    ".tag": "user",
                    "user": {
                        ".tag": "team_member",
                        "account_id": "dbid:AAGx4oiLtHdvRdNxUpvvJBXYgR4BS19c9kw",
                        "display_name": "Jane Smith",
                        "email": "jane_smith@acmecorp.com",
                        "team_member_id": "dbmid:AAFoi-tmvRuQR0jU-3fN4B-9nZo6nHcDO9Q",
                        "member_external_id": "ADSYNC S-1-5-21-1004296348-1135238915-682003432-1225",
                        "team": {
                            "display_name": "A Team"
                        }
                    }
                }
            ],
            "assets": [
                {
                    ".tag": "file",
                    "path": {
                        "namespace_relative": {
                            "ns_id": "1234",
                            "relative_path": "/Contract Work/Draft"
                        },
                        "contextual": "/Contract Work/Draft"
                    },
                    "display_name": "reports.xls",
                    "file_id": "id:jQKLsZFQImAAAAAAEZAAQt"
                }
            ]
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GetTeamEventsResult
events List of (TeamEvent) List of events. Note that events are not guaranteed to be sorted by their timestamp value.
TeamEvent
An audit log event.
timestamp Timestamp(format="%Y-%m-%dT%H:%M:%SZ") The Dropbox timestamp representing when the action was taken.
event_category EventCategory The category that this type of action belongs to.
EventCategory (open union)
Category of events in event audit log. The value will be one of the following datatypes. New values may be introduced as our API evolves.
apps Void Events that apply to management of linked apps.
comments Void Events that have to do with comments on files and Paper documents.
devices Void Events that apply to linked devices on mobile, desktop and Web platforms.
domains Void Events that involve domain management feature: domain verification, invite enforcement and account capture.
file_operations Void Events that have to do with filesystem operations on files and folders: copy, move, delete, etc.
file_requests Void Events that apply to the file requests feature.
groups Void Events that involve group management.
legal_holds Void Events that involve placing holds on content for litigation reasons
logins Void Events that involve users signing in to or out of Dropbox.
members Void Events that involve team member management.
paper Void Events that apply to Dropbox Paper.
passwords Void Events that involve using, changing or resetting passwords.
reports Void Events that concern generation of admin reports, including team activity and device usage.
sharing Void Events that apply to all types of sharing and collaboration.
showcase Void Events that apply to Dropbox Showcase.
sso Void Events that involve using or configuring single sign-on as well as administrative policies concerning single sign-on.
team_folders Void Events that involve team folder management.
team_policies Void Events that involve a change in team-wide policies.
team_profile Void Events that involve a change in the team profile.
tfa Void Events that involve using or configuring two factor authentication as well as administrative policies concerning two factor authentication.
trusted_teams Void Events that apply to cross-team trust establishment.
event_type EventType The particular type of action taken.
EventType (open union)
The type of the event. The value will be one of the following datatypes. New values may be introduced as our API evolves.
app_link_team AppLinkTeamType (apps) Linked app for team
AppLinkTeamType
description String
app_link_user AppLinkUserType (apps) Linked app for member
AppLinkUserType
description String
app_unlink_team AppUnlinkTeamType (apps) Unlinked app for team
AppUnlinkTeamType
description String
app_unlink_user AppUnlinkUserType (apps) Unlinked app for member
AppUnlinkUserType
description String
integration_connected IntegrationConnectedType (apps) Connected integration for member
IntegrationConnectedType
description String
integration_disconnected IntegrationDisconnectedType (apps) Disconnected integration for member
IntegrationDisconnectedType
description String
file_add_comment FileAddCommentType (comments) Added file comment
FileAddCommentType
description String
file_change_comment_subscription FileChangeCommentSubscriptionType (comments) Subscribed to or unsubscribed from comment notifications for file
FileChangeCommentSubscriptionType
description String
file_delete_comment FileDeleteCommentType (comments) Deleted file comment
FileDeleteCommentType
description String
file_edit_comment FileEditCommentType (comments) Edited file comment
FileEditCommentType
description String
file_like_comment FileLikeCommentType (comments) Liked file comment (deprecated, no longer logged)
FileLikeCommentType
description String
file_resolve_comment FileResolveCommentType (comments) Resolved file comment
FileResolveCommentType
description String
file_unlike_comment FileUnlikeCommentType (comments) Unliked file comment (deprecated, no longer logged)
FileUnlikeCommentType
description String
file_unresolve_comment FileUnresolveCommentType (comments) Unresolved file comment
FileUnresolveCommentType
description String
device_change_ip_desktop DeviceChangeIpDesktopType (devices) Changed IP address associated with active desktop session
DeviceChangeIpDesktopType
description String
device_change_ip_mobile DeviceChangeIpMobileType (devices) Changed IP address associated with active mobile session
DeviceChangeIpMobileType
description String
device_change_ip_web DeviceChangeIpWebType (devices) Changed IP address associated with active web session
DeviceChangeIpWebType
description String
device_delete_on_unlink_fail DeviceDeleteOnUnlinkFailType (devices) Failed to delete all files from unlinked device
DeviceDeleteOnUnlinkFailType
description String
device_delete_on_unlink_success DeviceDeleteOnUnlinkSuccessType (devices) Deleted all files from unlinked device
DeviceDeleteOnUnlinkSuccessType
description String
device_link_fail DeviceLinkFailType (devices) Failed to link device
DeviceLinkFailType
description String
device_link_success DeviceLinkSuccessType (devices) Linked device
DeviceLinkSuccessType
description String
device_management_disabled DeviceManagementDisabledType (devices) Disabled device management (deprecated, no longer logged)
DeviceManagementDisabledType
description String
device_management_enabled DeviceManagementEnabledType (devices) Enabled device management (deprecated, no longer logged)
DeviceManagementEnabledType
description String
device_unlink DeviceUnlinkType (devices) Disconnected device
DeviceUnlinkType
description String
emm_refresh_auth_token EmmRefreshAuthTokenType (devices) Refreshed auth token used for setting up EMM
EmmRefreshAuthTokenType
description String
account_capture_change_availability AccountCaptureChangeAvailabilityType (domains) Granted/revoked option to enable account capture on team domains
AccountCaptureChangeAvailabilityType
description String
account_capture_migrate_account AccountCaptureMigrateAccountType (domains) Account-captured user migrated account to team
AccountCaptureMigrateAccountType
description String
account_capture_notification_emails_sent AccountCaptureNotificationEmailsSentType (domains) Sent proactive account capture email to all unmanaged members
AccountCaptureNotificationEmailsSentType
description String
account_capture_relinquish_account AccountCaptureRelinquishAccountType (domains) Account-captured user changed account email to personal email
AccountCaptureRelinquishAccountType
description String
disabled_domain_invites DisabledDomainInvitesType (domains) Disabled domain invites (deprecated, no longer logged)
DisabledDomainInvitesType
description String
domain_invites_approve_request_to_join_team DomainInvitesApproveRequestToJoinTeamType (domains) Approved user's request to join team
DomainInvitesApproveRequestToJoinTeamType
description String
domain_invites_decline_request_to_join_team DomainInvitesDeclineRequestToJoinTeamType (domains) Declined user's request to join team
DomainInvitesDeclineRequestToJoinTeamType
description String
domain_invites_email_existing_users DomainInvitesEmailExistingUsersType (domains) Sent domain invites to existing domain accounts (deprecated, no longer logged)
DomainInvitesEmailExistingUsersType
description String
domain_invites_request_to_join_team DomainInvitesRequestToJoinTeamType (domains) Requested to join team
DomainInvitesRequestToJoinTeamType
description String
domain_invites_set_invite_new_user_pref_to_no DomainInvitesSetInviteNewUserPrefToNoType (domains) Disabled "Automatically invite new users" (deprecated, no longer logged)
DomainInvitesSetInviteNewUserPrefToNoType
description String
domain_invites_set_invite_new_user_pref_to_yes DomainInvitesSetInviteNewUserPrefToYesType (domains) Enabled "Automatically invite new users" (deprecated, no longer logged)
DomainInvitesSetInviteNewUserPrefToYesType
description String
domain_verification_add_domain_fail DomainVerificationAddDomainFailType (domains) Failed to verify team domain
DomainVerificationAddDomainFailType
description String
domain_verification_add_domain_success DomainVerificationAddDomainSuccessType (domains) Verified team domain
DomainVerificationAddDomainSuccessType
description String
domain_verification_remove_domain DomainVerificationRemoveDomainType (domains) Removed domain from list of verified team domains
DomainVerificationRemoveDomainType
description String
enabled_domain_invites EnabledDomainInvitesType (domains) Enabled domain invites (deprecated, no longer logged)
EnabledDomainInvitesType
description String
create_folder CreateFolderType (file_operations) Created folders (deprecated, no longer logged)
CreateFolderType
description String
file_add FileAddType (file_operations) Added files and/or folders
FileAddType
description String
file_copy FileCopyType (file_operations) Copied files and/or folders
FileCopyType
description String
file_delete FileDeleteType (file_operations) Deleted files and/or folders
FileDeleteType
description String
file_download FileDownloadType (file_operations) Downloaded files and/or folders
FileDownloadType
description String
file_edit FileEditType (file_operations) Edited files
FileEditType
description String
file_get_copy_reference FileGetCopyReferenceType (file_operations) Created copy reference to file/folder
FileGetCopyReferenceType
description String
file_move FileMoveType (file_operations) Moved files and/or folders
FileMoveType
description String
file_permanently_delete FilePermanentlyDeleteType (file_operations) Permanently deleted files and/or folders
FilePermanentlyDeleteType
description String
file_preview FilePreviewType (file_operations) Previewed files and/or folders
FilePreviewType
description String
file_rename FileRenameType (file_operations) Renamed files and/or folders
FileRenameType
description String
file_restore FileRestoreType (file_operations) Restored deleted files and/or folders
FileRestoreType
description String
file_revert FileRevertType (file_operations) Reverted files to previous version
FileRevertType
description String
file_rollback_changes FileRollbackChangesType (file_operations) Rolled back file actions
FileRollbackChangesType
description String
file_save_copy_reference FileSaveCopyReferenceType (file_operations) Saved file/folder using copy reference
FileSaveCopyReferenceType
description String
folder_overview_description_changed FolderOverviewDescriptionChangedType (file_operations) Updated folder overview
FolderOverviewDescriptionChangedType
description String
folder_overview_item_pinned FolderOverviewItemPinnedType (file_operations) Pinned item to folder overview
FolderOverviewItemPinnedType
description String
folder_overview_item_unpinned FolderOverviewItemUnpinnedType (file_operations) Unpinned item from folder overview
FolderOverviewItemUnpinnedType
description String
file_request_change FileRequestChangeType (file_requests) Changed file request
FileRequestChangeType
description String
file_request_close FileRequestCloseType (file_requests) Closed file request
FileRequestCloseType
description String
file_request_create FileRequestCreateType (file_requests) Created file request
FileRequestCreateType
description String
file_request_delete FileRequestDeleteType (file_requests) Delete file request
FileRequestDeleteType
description String
file_request_receive_file FileRequestReceiveFileType (file_requests) Received files for file request
FileRequestReceiveFileType
description String
group_add_external_id GroupAddExternalIdType (groups) Added external ID for group
GroupAddExternalIdType
description String
group_add_member GroupAddMemberType (groups) Added team members to group
GroupAddMemberType
description String
group_change_external_id GroupChangeExternalIdType (groups) Changed external ID for group
GroupChangeExternalIdType
description String
group_change_management_type GroupChangeManagementTypeType (groups) Changed group management type
GroupChangeManagementTypeType
description String
group_change_member_role GroupChangeMemberRoleType (groups) Changed manager permissions of group member
GroupChangeMemberRoleType
description String
group_create GroupCreateType (groups) Created group
GroupCreateType
description String
group_delete GroupDeleteType (groups) Deleted group
GroupDeleteType
description String
group_description_updated GroupDescriptionUpdatedType (groups) Updated group (deprecated, no longer logged)
GroupDescriptionUpdatedType
description String
group_join_policy_updated GroupJoinPolicyUpdatedType (groups) Updated group join policy (deprecated, no longer logged)
GroupJoinPolicyUpdatedType
description String
group_moved GroupMovedType (groups) Moved group (deprecated, no longer logged)
GroupMovedType
description String
group_remove_external_id GroupRemoveExternalIdType (groups) Removed external ID for group
GroupRemoveExternalIdType
description String
group_remove_member GroupRemoveMemberType (groups) Removed team members from group
GroupRemoveMemberType
description String
group_rename GroupRenameType (groups) Renamed group
GroupRenameType
description String
legal_holds_activate_a_hold LegalHoldsActivateAHoldType (legal_holds) Activated a hold
LegalHoldsActivateAHoldType
description String
legal_holds_add_members LegalHoldsAddMembersType (legal_holds) Added members to a hold
LegalHoldsAddMembersType
description String
legal_holds_change_hold_details LegalHoldsChangeHoldDetailsType (legal_holds) Edited details for a hold
LegalHoldsChangeHoldDetailsType
description String
legal_holds_change_hold_name LegalHoldsChangeHoldNameType (legal_holds) Renamed a hold
LegalHoldsChangeHoldNameType
description String
legal_holds_export_a_hold LegalHoldsExportAHoldType (legal_holds) Exported hold
LegalHoldsExportAHoldType
description String
legal_holds_release_a_hold LegalHoldsReleaseAHoldType (legal_holds) Released a hold
LegalHoldsReleaseAHoldType
description String
legal_holds_remove_members LegalHoldsRemoveMembersType (legal_holds) Removed members from a hold
LegalHoldsRemoveMembersType
description String
legal_holds_report_a_hold LegalHoldsReportAHoldType (legal_holds) Created a summary report for a hold
LegalHoldsReportAHoldType
description String
emm_error EmmErrorType (logins) Failed to sign in via EMM (deprecated, replaced by 'Failed to sign in')
EmmErrorType
description String
guest_admin_signed_in_via_trusted_teams GuestAdminSignedInViaTrustedTeamsType (logins) Started trusted team admin session
GuestAdminSignedInViaTrustedTeamsType
description String
guest_admin_signed_out_via_trusted_teams GuestAdminSignedOutViaTrustedTeamsType (logins) Ended trusted team admin session
GuestAdminSignedOutViaTrustedTeamsType
description String
login_fail LoginFailType (logins) Failed to sign in
LoginFailType
description String
login_success LoginSuccessType (logins) Signed in
LoginSuccessType
description String
logout LogoutType (logins) Signed out
LogoutType
description String
reseller_support_session_end ResellerSupportSessionEndType (logins) Ended reseller support session
ResellerSupportSessionEndType
description String
reseller_support_session_start ResellerSupportSessionStartType (logins) Started reseller support session
ResellerSupportSessionStartType
description String
sign_in_as_session_end SignInAsSessionEndType (logins) Ended admin sign-in-as session
SignInAsSessionEndType
description String
sign_in_as_session_start SignInAsSessionStartType (logins) Started admin sign-in-as session
SignInAsSessionStartType
description String
sso_error SsoErrorType (logins) Failed to sign in via SSO (deprecated, replaced by 'Failed to sign in')
SsoErrorType
description String
member_add_external_id MemberAddExternalIdType (members) Added an external ID for team member
MemberAddExternalIdType
description String
member_add_name MemberAddNameType (members) Added team member name
MemberAddNameType
description String
member_change_admin_role MemberChangeAdminRoleType (members) Changed team member admin role
MemberChangeAdminRoleType
description String
member_change_email MemberChangeEmailType (members) Changed team member email
MemberChangeEmailType
description String
member_change_external_id MemberChangeExternalIdType (members) Changed the external ID for team member
MemberChangeExternalIdType
description String
member_change_membership_type MemberChangeMembershipTypeType (members) Changed membership type (limited/full) of member (deprecated, no longer logged)
MemberChangeMembershipTypeType
description String
member_change_name MemberChangeNameType (members) Changed team member name
MemberChangeNameType
description String
member_change_status MemberChangeStatusType (members) Changed member status (invited, joined, suspended, etc.)
MemberChangeStatusType
description String
member_delete_manual_contacts MemberDeleteManualContactsType (members) Cleared manually added contacts
MemberDeleteManualContactsType
description String
member_delete_profile_photo MemberDeleteProfilePhotoType (members) Deleted team member profile photo
MemberDeleteProfilePhotoType
description String
member_permanently_delete_account_contents MemberPermanentlyDeleteAccountContentsType (members) Permanently deleted contents of deleted team member account
MemberPermanentlyDeleteAccountContentsType
description String
member_remove_external_id MemberRemoveExternalIdType (members) Removed the external ID for team member
MemberRemoveExternalIdType
description String
member_set_profile_photo MemberSetProfilePhotoType (members) Set team member profile photo
MemberSetProfilePhotoType
description String
member_space_limits_add_custom_quota MemberSpaceLimitsAddCustomQuotaType (members) Set custom member space limit
MemberSpaceLimitsAddCustomQuotaType
description String
member_space_limits_change_custom_quota MemberSpaceLimitsChangeCustomQuotaType (members) Changed custom member space limit
MemberSpaceLimitsChangeCustomQuotaType
description String
member_space_limits_change_status MemberSpaceLimitsChangeStatusType (members) Changed space limit status
MemberSpaceLimitsChangeStatusType
description String
member_space_limits_remove_custom_quota MemberSpaceLimitsRemoveCustomQuotaType (members) Removed custom member space limit
MemberSpaceLimitsRemoveCustomQuotaType
description String
member_suggest MemberSuggestType (members) Suggested person to add to team
MemberSuggestType
description String
member_transfer_account_contents MemberTransferAccountContentsType (members) Transferred contents of deleted member account to another member
MemberTransferAccountContentsType
description String
pending_secondary_email_added PendingSecondaryEmailAddedType (members) Added pending secondary email
PendingSecondaryEmailAddedType
description String
secondary_email_deleted SecondaryEmailDeletedType (members) Deleted secondary email
SecondaryEmailDeletedType
description String
secondary_email_verified SecondaryEmailVerifiedType (members) Verified secondary email
SecondaryEmailVerifiedType
description String
secondary_mails_policy_changed SecondaryMailsPolicyChangedType (members) Secondary mails policy changed
SecondaryMailsPolicyChangedType
description String
paper_content_add_member PaperContentAddMemberType (paper) Added users and/or groups to Paper doc/folder
PaperContentAddMemberType
description String
paper_content_add_to_folder PaperContentAddToFolderType (paper) Added Paper doc/folder to folder
PaperContentAddToFolderType
description String
paper_content_archive PaperContentArchiveType (paper) Archived Paper doc/folder
PaperContentArchiveType
description String
paper_content_create PaperContentCreateType (paper) Created Paper doc/folder
PaperContentCreateType
description String
paper_content_permanently_delete PaperContentPermanentlyDeleteType (paper) Permanently deleted Paper doc/folder
PaperContentPermanentlyDeleteType
description String
paper_content_remove_from_folder PaperContentRemoveFromFolderType (paper) Removed Paper doc/folder from folder
PaperContentRemoveFromFolderType
description String
paper_content_remove_member PaperContentRemoveMemberType (paper) Removed users and/or groups from Paper doc/folder
PaperContentRemoveMemberType
description String
paper_content_rename PaperContentRenameType (paper) Renamed Paper doc/folder
PaperContentRenameType
description String
paper_content_restore PaperContentRestoreType (paper) Restored archived Paper doc/folder
PaperContentRestoreType
description String
paper_doc_add_comment PaperDocAddCommentType (paper) Added Paper doc comment
PaperDocAddCommentType
description String
paper_doc_change_member_role PaperDocChangeMemberRoleType (paper) Changed member permissions for Paper doc
PaperDocChangeMemberRoleType
description String
paper_doc_change_sharing_policy PaperDocChangeSharingPolicyType (paper) Changed sharing setting for Paper doc
PaperDocChangeSharingPolicyType
description String
paper_doc_change_subscription PaperDocChangeSubscriptionType (paper) Followed/unfollowed Paper doc
PaperDocChangeSubscriptionType
description String
paper_doc_deleted PaperDocDeletedType (paper) Archived Paper doc (deprecated, no longer logged)
PaperDocDeletedType
description String
paper_doc_delete_comment PaperDocDeleteCommentType (paper) Deleted Paper doc comment
PaperDocDeleteCommentType
description String
paper_doc_download PaperDocDownloadType (paper) Downloaded Paper doc in specific format
PaperDocDownloadType
description String
paper_doc_edit PaperDocEditType (paper) Edited Paper doc
PaperDocEditType
description String
paper_doc_edit_comment PaperDocEditCommentType (paper) Edited Paper doc comment
PaperDocEditCommentType
description String
paper_doc_followed PaperDocFollowedType (paper) Followed Paper doc (deprecated, replaced by 'Followed/unfollowed Paper doc')
PaperDocFollowedType
description String
paper_doc_mention PaperDocMentionType (paper) Mentioned user in Paper doc
PaperDocMentionType
description String
paper_doc_ownership_changed PaperDocOwnershipChangedType (paper) Transferred ownership of Paper doc
PaperDocOwnershipChangedType
description String
paper_doc_request_access PaperDocRequestAccessType (paper) Requested access to Paper doc
PaperDocRequestAccessType
description String
paper_doc_resolve_comment PaperDocResolveCommentType (paper) Resolved Paper doc comment
PaperDocResolveCommentType
description String
paper_doc_revert PaperDocRevertType (paper) Restored Paper doc to previous version
PaperDocRevertType
description String
paper_doc_slack_share PaperDocSlackShareType (paper) Shared Paper doc via Slack
PaperDocSlackShareType
description String
paper_doc_team_invite PaperDocTeamInviteType (paper) Shared Paper doc with users and/or groups (deprecated, no longer logged)
PaperDocTeamInviteType
description String
paper_doc_trashed PaperDocTrashedType (paper) Deleted Paper doc
PaperDocTrashedType
description String
paper_doc_unresolve_comment PaperDocUnresolveCommentType (paper) Unresolved Paper doc comment
PaperDocUnresolveCommentType
description String
paper_doc_untrashed PaperDocUntrashedType (paper) Restored Paper doc
PaperDocUntrashedType
description String
paper_doc_view PaperDocViewType (paper) Viewed Paper doc
PaperDocViewType
description String
paper_external_view_allow PaperExternalViewAllowType (paper) Changed Paper external sharing setting to anyone (deprecated, no longer logged)
PaperExternalViewAllowType
description String
paper_external_view_default_team PaperExternalViewDefaultTeamType (paper) Changed Paper external sharing setting to default team (deprecated, no longer logged)
PaperExternalViewDefaultTeamType
description String
paper_external_view_forbid PaperExternalViewForbidType (paper) Changed Paper external sharing setting to team-only (deprecated, no longer logged)
PaperExternalViewForbidType
description String
paper_folder_change_subscription PaperFolderChangeSubscriptionType (paper) Followed/unfollowed Paper folder
PaperFolderChangeSubscriptionType
description String
paper_folder_deleted PaperFolderDeletedType (paper) Archived Paper folder (deprecated, no longer logged)
PaperFolderDeletedType
description String
paper_folder_followed PaperFolderFollowedType (paper) Followed Paper folder (deprecated, replaced by 'Followed/unfollowed Paper folder')
PaperFolderFollowedType
description String
paper_folder_team_invite PaperFolderTeamInviteType (paper) Shared Paper folder with users and/or groups (deprecated, no longer logged)
PaperFolderTeamInviteType
description String
paper_published_link_change_permission PaperPublishedLinkChangePermissionType (paper) Changed permissions for published doc
PaperPublishedLinkChangePermissionType
description String
paper_published_link_create PaperPublishedLinkCreateType (paper) Published doc
PaperPublishedLinkCreateType
description String
paper_published_link_disabled PaperPublishedLinkDisabledType (paper) Unpublished doc
PaperPublishedLinkDisabledType
description String
paper_published_link_view PaperPublishedLinkViewType (paper) Viewed published doc
PaperPublishedLinkViewType
description String
password_change PasswordChangeType (passwords) Changed password
PasswordChangeType
description String
password_reset PasswordResetType (passwords) Reset password
PasswordResetType
description String
password_reset_all PasswordResetAllType (passwords) Reset all team member passwords
PasswordResetAllType
description String
emm_create_exceptions_report EmmCreateExceptionsReportType (reports) Created EMM-excluded users report
EmmCreateExceptionsReportType
description String
emm_create_usage_report EmmCreateUsageReportType (reports) Created EMM mobile app usage report
EmmCreateUsageReportType
description String
export_members_report ExportMembersReportType (reports) Created member data report
ExportMembersReportType
description String
export_members_report_fail ExportMembersReportFailType (reports) Failed to create members data report
ExportMembersReportFailType
description String
paper_admin_export_start PaperAdminExportStartType (reports) Exported all team Paper docs
PaperAdminExportStartType
description String
smart_sync_create_admin_privilege_report SmartSyncCreateAdminPrivilegeReportType (reports) Created Smart Sync non-admin devices report
SmartSyncCreateAdminPrivilegeReportType
description String
team_activity_create_report TeamActivityCreateReportType (reports) Created team activity report
TeamActivityCreateReportType
description String
team_activity_create_report_fail TeamActivityCreateReportFailType (reports) Couldn't generate team activity report
TeamActivityCreateReportFailType
description String
collection_share CollectionShareType (sharing) Shared album
CollectionShareType
description String
file_transfers_file_add FileTransfersFileAddType (sharing) Transfer files added
FileTransfersFileAddType
description String
file_transfers_transfer_delete FileTransfersTransferDeleteType (sharing) Deleted transfer
FileTransfersTransferDeleteType
description String
file_transfers_transfer_download FileTransfersTransferDownloadType (sharing) Transfer downloaded
FileTransfersTransferDownloadType
description String
file_transfers_transfer_send FileTransfersTransferSendType (sharing) Sent transfer
FileTransfersTransferSendType
description String
file_transfers_transfer_view FileTransfersTransferViewType (sharing) Viewed transfer
FileTransfersTransferViewType
description String
note_acl_invite_only NoteAclInviteOnlyType (sharing) Changed Paper doc to invite-only (deprecated, no longer logged)
NoteAclInviteOnlyType
description String
note_acl_link NoteAclLinkType (sharing) Changed Paper doc to link-accessible (deprecated, no longer logged)
NoteAclLinkType
description String
note_acl_team_link NoteAclTeamLinkType (sharing) Changed Paper doc to link-accessible for team (deprecated, no longer logged)
NoteAclTeamLinkType
description String
note_shared NoteSharedType (sharing) Shared Paper doc (deprecated, no longer logged)
NoteSharedType
description String
note_share_receive NoteShareReceiveType (sharing) Shared received Paper doc (deprecated, no longer logged)
NoteShareReceiveType
description String
open_note_shared OpenNoteSharedType (sharing) Opened shared Paper doc (deprecated, no longer logged)
OpenNoteSharedType
description String
sf_add_group SfAddGroupType (sharing) Added team to shared folder (deprecated, no longer logged)
SfAddGroupType
description String
sf_allow_non_members_to_view_shared_links SfAllowNonMembersToViewSharedLinksType (sharing) Allowed non-collaborators to view links to files in shared folder (deprecated, no longer logged)
SfAllowNonMembersToViewSharedLinksType
description String
sf_external_invite_warn SfExternalInviteWarnType (sharing) Set team members to see warning before sharing folders outside team (deprecated, no longer logged)
SfExternalInviteWarnType
description String
sf_fb_invite SfFbInviteType (sharing) Invited Facebook users to shared folder (deprecated, no longer logged)
SfFbInviteType
description String
sf_fb_invite_change_role SfFbInviteChangeRoleType (sharing) Changed Facebook user's role in shared folder (deprecated, no longer logged)
SfFbInviteChangeRoleType
description String
sf_fb_uninvite SfFbUninviteType (sharing) Uninvited Facebook user from shared folder (deprecated, no longer logged)
SfFbUninviteType
description String
sf_invite_group SfInviteGroupType (sharing) Invited group to shared folder (deprecated, no longer logged)
SfInviteGroupType
description String
sf_team_grant_access SfTeamGrantAccessType (sharing) Granted access to shared folder (deprecated, no longer logged)
SfTeamGrantAccessType
description String
sf_team_invite SfTeamInviteType (sharing) Invited team members to shared folder (deprecated, replaced by 'Invited user to Dropbox and added them to shared file/folder')
SfTeamInviteType
description String
sf_team_invite_change_role SfTeamInviteChangeRoleType (sharing) Changed team member's role in shared folder (deprecated, no longer logged)
SfTeamInviteChangeRoleType
description String
sf_team_join SfTeamJoinType (sharing) Joined team member's shared folder (deprecated, no longer logged)
SfTeamJoinType
description String
sf_team_join_from_oob_link SfTeamJoinFromOobLinkType (sharing) Joined team member's shared folder from link (deprecated, no longer logged)
SfTeamJoinFromOobLinkType
description String
sf_team_uninvite SfTeamUninviteType (sharing) Unshared folder with team member (deprecated, replaced by 'Removed invitee from shared file/folder before invite was accepted')
SfTeamUninviteType
description String
shared_content_add_invitees SharedContentAddInviteesType (sharing) Invited user to Dropbox and added them to shared file/folder
SharedContentAddInviteesType
description String
shared_content_add_link_expiry SharedContentAddLinkExpiryType (sharing) Added expiration date to link for shared file/folder (deprecated, no longer logged)
SharedContentAddLinkExpiryType
description String
shared_content_add_link_password SharedContentAddLinkPasswordType (sharing) Added password to link for shared file/folder (deprecated, no longer logged)
SharedContentAddLinkPasswordType
description String
shared_content_add_member SharedContentAddMemberType (sharing) Added users and/or groups to shared file/folder
SharedContentAddMemberType
description String
shared_content_change_downloads_policy SharedContentChangeDownloadsPolicyType (sharing) Changed whether members can download shared file/folder (deprecated, no longer logged)
SharedContentChangeDownloadsPolicyType
description String
shared_content_change_invitee_role SharedContentChangeInviteeRoleType (sharing) Changed access type of invitee to shared file/folder before invite was accepted
SharedContentChangeInviteeRoleType
description String
shared_content_change_link_audience SharedContentChangeLinkAudienceType (sharing) Changed link audience of shared file/folder (deprecated, no longer logged)
SharedContentChangeLinkAudienceType
description String
shared_content_change_link_expiry SharedContentChangeLinkExpiryType (sharing) Changed link expiration of shared file/folder (deprecated, no longer logged)
SharedContentChangeLinkExpiryType
description String
shared_content_change_link_password SharedContentChangeLinkPasswordType (sharing) Changed link password of shared file/folder (deprecated, no longer logged)
SharedContentChangeLinkPasswordType
description String
shared_content_change_member_role SharedContentChangeMemberRoleType (sharing) Changed access type of shared file/folder member
SharedContentChangeMemberRoleType
description String
shared_content_change_viewer_info_policy SharedContentChangeViewerInfoPolicyType (sharing) Changed whether members can see who viewed shared file/folder
SharedContentChangeViewerInfoPolicyType
description String
shared_content_claim_invitation SharedContentClaimInvitationType (sharing) Acquired membership of shared file/folder by accepting invite
SharedContentClaimInvitationType
description String
shared_content_copy SharedContentCopyType (sharing) Copied shared file/folder to own Dropbox
SharedContentCopyType
description String
shared_content_download SharedContentDownloadType (sharing) Downloaded shared file/folder
SharedContentDownloadType
description String
shared_content_relinquish_membership SharedContentRelinquishMembershipType (sharing) Left shared file/folder
SharedContentRelinquishMembershipType
description String
shared_content_remove_invitees SharedContentRemoveInviteesType (sharing) Removed invitee from shared file/folder before invite was accepted
SharedContentRemoveInviteesType
description String
shared_content_remove_link_expiry SharedContentRemoveLinkExpiryType (sharing) Removed link expiration date of shared file/folder (deprecated, no longer logged)
SharedContentRemoveLinkExpiryType
description String
shared_content_remove_link_password SharedContentRemoveLinkPasswordType (sharing) Removed link password of shared file/folder (deprecated, no longer logged)
SharedContentRemoveLinkPasswordType
description String
shared_content_remove_member SharedContentRemoveMemberType (sharing) Removed user/group from shared file/folder
SharedContentRemoveMemberType
description String
shared_content_request_access SharedContentRequestAccessType (sharing) Requested access to shared file/folder
SharedContentRequestAccessType
description String
shared_content_restore_invitees SharedContentRestoreInviteesType (sharing) Restored shared file/folder invitees
SharedContentRestoreInviteesType
description String
shared_content_restore_member SharedContentRestoreMemberType (sharing) Restored users and/or groups to membership of shared file/folder
SharedContentRestoreMemberType
description String
shared_content_unshare SharedContentUnshareType (sharing) Unshared file/folder by clearing membership
SharedContentUnshareType
description String
shared_content_view SharedContentViewType (sharing) Previewed shared file/folder
SharedContentViewType
description String
shared_folder_change_link_policy SharedFolderChangeLinkPolicyType (sharing) Changed who can access shared folder via link
SharedFolderChangeLinkPolicyType
description String
shared_folder_change_members_inheritance_policy SharedFolderChangeMembersInheritancePolicyType (sharing) Changed whether shared folder inherits members from parent folder
SharedFolderChangeMembersInheritancePolicyType
description String
shared_folder_change_members_management_policy SharedFolderChangeMembersManagementPolicyType (sharing) Changed who can add/remove members of shared folder
SharedFolderChangeMembersManagementPolicyType
description String
shared_folder_change_members_policy SharedFolderChangeMembersPolicyType (sharing) Changed who can become member of shared folder
SharedFolderChangeMembersPolicyType
description String
shared_folder_create SharedFolderCreateType (sharing) Created shared folder
SharedFolderCreateType
description String
shared_folder_decline_invitation SharedFolderDeclineInvitationType (sharing) Declined team member's invite to shared folder
SharedFolderDeclineInvitationType
description String
shared_folder_mount SharedFolderMountType (sharing) Added shared folder to own Dropbox
SharedFolderMountType
description String
shared_folder_nest SharedFolderNestType (sharing) Changed parent of shared folder
SharedFolderNestType
description String
shared_folder_transfer_ownership SharedFolderTransferOwnershipType (sharing) Transferred ownership of shared folder to another member
SharedFolderTransferOwnershipType
description String
shared_folder_unmount SharedFolderUnmountType (sharing) Deleted shared folder from Dropbox
SharedFolderUnmountType
description String
shared_link_add_expiry SharedLinkAddExpiryType (sharing) Added shared link expiration date
SharedLinkAddExpiryType
description String
shared_link_change_expiry SharedLinkChangeExpiryType (sharing) Changed shared link expiration date
SharedLinkChangeExpiryType
description String
shared_link_change_visibility SharedLinkChangeVisibilityType (sharing) Changed visibility of shared link
SharedLinkChangeVisibilityType
description String
shared_link_copy SharedLinkCopyType (sharing) Added file/folder to Dropbox from shared link
SharedLinkCopyType
description String
shared_link_create SharedLinkCreateType (sharing) Created shared link
SharedLinkCreateType
description String
shared_link_disable SharedLinkDisableType (sharing) Removed shared link
SharedLinkDisableType
description String
shared_link_download SharedLinkDownloadType (sharing) Downloaded file/folder from shared link
SharedLinkDownloadType
description String
shared_link_remove_expiry SharedLinkRemoveExpiryType (sharing) Removed shared link expiration date
SharedLinkRemoveExpiryType
description String
shared_link_share SharedLinkShareType (sharing) Added members as audience of shared link
SharedLinkShareType
description String
shared_link_view SharedLinkViewType (sharing) Opened shared link
SharedLinkViewType
description String
shared_note_opened SharedNoteOpenedType (sharing) Opened shared Paper doc (deprecated, no longer logged)
SharedNoteOpenedType
description String
shmodel_group_share ShmodelGroupShareType (sharing) Shared link with group (deprecated, no longer logged)
ShmodelGroupShareType
description String
showcase_access_granted ShowcaseAccessGrantedType (showcase) Granted access to showcase
ShowcaseAccessGrantedType
description String
showcase_add_member ShowcaseAddMemberType (showcase) Added member to showcase
ShowcaseAddMemberType
description String
showcase_archived ShowcaseArchivedType (showcase) Archived showcase
ShowcaseArchivedType
description String
showcase_created ShowcaseCreatedType (showcase) Created showcase
ShowcaseCreatedType
description String
showcase_delete_comment ShowcaseDeleteCommentType (showcase) Deleted showcase comment
ShowcaseDeleteCommentType
description String
showcase_edited ShowcaseEditedType (showcase) Edited showcase
ShowcaseEditedType
description String
showcase_edit_comment ShowcaseEditCommentType (showcase) Edited showcase comment
ShowcaseEditCommentType
description String
showcase_file_added ShowcaseFileAddedType (showcase) Added file to showcase
ShowcaseFileAddedType
description String
showcase_file_download ShowcaseFileDownloadType (showcase) Downloaded file from showcase
ShowcaseFileDownloadType
description String
showcase_file_removed ShowcaseFileRemovedType (showcase) Removed file from showcase
ShowcaseFileRemovedType
description String
showcase_file_view ShowcaseFileViewType (showcase) Viewed file in showcase
ShowcaseFileViewType
description String
showcase_permanently_deleted ShowcasePermanentlyDeletedType (showcase) Permanently deleted showcase
ShowcasePermanentlyDeletedType
description String
showcase_post_comment ShowcasePostCommentType (showcase) Added showcase comment
ShowcasePostCommentType
description String
showcase_remove_member ShowcaseRemoveMemberType (showcase) Removed member from showcase
ShowcaseRemoveMemberType
description String
showcase_renamed ShowcaseRenamedType (showcase) Renamed showcase
ShowcaseRenamedType
description String
showcase_request_access ShowcaseRequestAccessType (showcase) Requested access to showcase
ShowcaseRequestAccessType
description String
showcase_resolve_comment ShowcaseResolveCommentType (showcase) Resolved showcase comment
ShowcaseResolveCommentType
description String
showcase_restored ShowcaseRestoredType (showcase) Unarchived showcase
ShowcaseRestoredType
description String
showcase_trashed ShowcaseTrashedType (showcase) Deleted showcase
ShowcaseTrashedType
description String
showcase_trashed_deprecated ShowcaseTrashedDeprecatedType (showcase) Deleted showcase (old version) (deprecated, replaced by 'Deleted showcase')
ShowcaseTrashedDeprecatedType
description String
showcase_unresolve_comment ShowcaseUnresolveCommentType (showcase) Unresolved showcase comment
ShowcaseUnresolveCommentType
description String
showcase_untrashed ShowcaseUntrashedType (showcase) Restored showcase
ShowcaseUntrashedType
description String
showcase_untrashed_deprecated ShowcaseUntrashedDeprecatedType (showcase) Restored showcase (old version) (deprecated, replaced by 'Restored showcase')
ShowcaseUntrashedDeprecatedType
description String
showcase_view ShowcaseViewType (showcase) Viewed showcase
ShowcaseViewType
description String
sso_add_cert SsoAddCertType (sso) Added X.509 certificate for SSO
SsoAddCertType
description String
sso_add_login_url SsoAddLoginUrlType (sso) Added sign-in URL for SSO
SsoAddLoginUrlType
description String
sso_add_logout_url SsoAddLogoutUrlType (sso) Added sign-out URL for SSO
SsoAddLogoutUrlType
description String
sso_change_cert SsoChangeCertType (sso) Changed X.509 certificate for SSO
SsoChangeCertType
description String
sso_change_login_url SsoChangeLoginUrlType (sso) Changed sign-in URL for SSO
SsoChangeLoginUrlType
description String
sso_change_logout_url SsoChangeLogoutUrlType (sso) Changed sign-out URL for SSO
SsoChangeLogoutUrlType
description String
sso_change_saml_identity_mode SsoChangeSamlIdentityModeType (sso) Changed SAML identity mode for SSO
SsoChangeSamlIdentityModeType
description String
sso_remove_cert SsoRemoveCertType (sso) Removed X.509 certificate for SSO
SsoRemoveCertType
description String
sso_remove_login_url SsoRemoveLoginUrlType (sso) Removed sign-in URL for SSO
SsoRemoveLoginUrlType
description String
sso_remove_logout_url SsoRemoveLogoutUrlType (sso) Removed sign-out URL for SSO
SsoRemoveLogoutUrlType
description String
team_folder_change_status TeamFolderChangeStatusType (team_folders) Changed archival status of team folder
TeamFolderChangeStatusType
description String
team_folder_create TeamFolderCreateType (team_folders) Created team folder in active status
TeamFolderCreateType
description String
team_folder_downgrade TeamFolderDowngradeType (team_folders) Downgraded team folder to regular shared folder
TeamFolderDowngradeType
description String
team_folder_permanently_delete TeamFolderPermanentlyDeleteType (team_folders) Permanently deleted archived team folder
TeamFolderPermanentlyDeleteType
description String
team_folder_rename TeamFolderRenameType (team_folders) Renamed active/archived team folder
TeamFolderRenameType
description String
team_selective_sync_settings_changed TeamSelectiveSyncSettingsChangedType (team_folders) Changed sync default
TeamSelectiveSyncSettingsChangedType
description String
account_capture_change_policy AccountCaptureChangePolicyType (team_policies) Changed account capture setting on team domain
AccountCaptureChangePolicyType
description String
allow_download_disabled AllowDownloadDisabledType (team_policies) Disabled downloads (deprecated, no longer logged)
AllowDownloadDisabledType
description String
allow_download_enabled AllowDownloadEnabledType (team_policies) Enabled downloads (deprecated, no longer logged)
AllowDownloadEnabledType
description String
camera_uploads_policy_changed CameraUploadsPolicyChangedType (team_policies) Changed camera uploads setting for team
CameraUploadsPolicyChangedType
description String
data_placement_restriction_change_policy DataPlacementRestrictionChangePolicyType (team_policies) Set restrictions on data center locations where team data resides
DataPlacementRestrictionChangePolicyType
description String
data_placement_restriction_satisfy_policy DataPlacementRestrictionSatisfyPolicyType (team_policies) Completed restrictions on data center locations where team data resides
DataPlacementRestrictionSatisfyPolicyType
description String
device_approvals_add_exception DeviceApprovalsAddExceptionType (team_policies) Added members to device approvals exception list
DeviceApprovalsAddExceptionType
description String
device_approvals_change_desktop_policy DeviceApprovalsChangeDesktopPolicyType (team_policies) Set/removed limit on number of computers member can link to team Dropbox account
DeviceApprovalsChangeDesktopPolicyType
description String
device_approvals_change_mobile_policy DeviceApprovalsChangeMobilePolicyType (team_policies) Set/removed limit on number of mobile devices member can link to team Dropbox account
DeviceApprovalsChangeMobilePolicyType
description String
device_approvals_change_overage_action DeviceApprovalsChangeOverageActionType (team_policies) Changed device approvals setting when member is over limit
DeviceApprovalsChangeOverageActionType
description String
device_approvals_change_unlink_action DeviceApprovalsChangeUnlinkActionType (team_policies) Changed device approvals setting when member unlinks approved device
DeviceApprovalsChangeUnlinkActionType
description String
device_approvals_remove_exception DeviceApprovalsRemoveExceptionType (team_policies) Removed members from device approvals exception list
DeviceApprovalsRemoveExceptionType
description String
directory_restrictions_add_members DirectoryRestrictionsAddMembersType (team_policies) Added members to directory restrictions list
DirectoryRestrictionsAddMembersType
description String
directory_restrictions_remove_members DirectoryRestrictionsRemoveMembersType (team_policies) Removed members from directory restrictions list
DirectoryRestrictionsRemoveMembersType
description String
emm_add_exception EmmAddExceptionType (team_policies) Added members to EMM exception list
EmmAddExceptionType
description String
emm_change_policy EmmChangePolicyType (team_policies) Enabled/disabled enterprise mobility management for members
EmmChangePolicyType
description String
emm_remove_exception EmmRemoveExceptionType (team_policies) Removed members from EMM exception list
EmmRemoveExceptionType
description String
extended_version_history_change_policy ExtendedVersionHistoryChangePolicyType (team_policies) Accepted/opted out of extended version history
ExtendedVersionHistoryChangePolicyType
description String
file_comments_change_policy FileCommentsChangePolicyType (team_policies) Enabled/disabled commenting on team files
FileCommentsChangePolicyType
description String
file_locking_policy_changed FileLockingPolicyChangedType (team_policies) Changed file locking policy for team
FileLockingPolicyChangedType
description String
file_requests_change_policy FileRequestsChangePolicyType (team_policies) Enabled/disabled file requests
FileRequestsChangePolicyType
description String
file_requests_emails_enabled FileRequestsEmailsEnabledType (team_policies) Enabled file request emails for everyone (deprecated, no longer logged)
FileRequestsEmailsEnabledType
description String
file_requests_emails_restricted_to_team_only FileRequestsEmailsRestrictedToTeamOnlyType (team_policies) Enabled file request emails for team (deprecated, no longer logged)
FileRequestsEmailsRestrictedToTeamOnlyType
description String
file_transfers_policy_changed FileTransfersPolicyChangedType (team_policies) Changed file transfers policy for team
FileTransfersPolicyChangedType
description String
google_sso_change_policy GoogleSsoChangePolicyType (team_policies) Enabled/disabled Google single sign-on for team
GoogleSsoChangePolicyType
description String
group_user_management_change_policy GroupUserManagementChangePolicyType (team_policies) Changed who can create groups
GroupUserManagementChangePolicyType
description String
integration_policy_changed IntegrationPolicyChangedType (team_policies) Changed integration policy for team
IntegrationPolicyChangedType
description String
member_requests_change_policy MemberRequestsChangePolicyType (team_policies) Changed whether users can find team when not invited
MemberRequestsChangePolicyType
description String
member_space_limits_add_exception MemberSpaceLimitsAddExceptionType (team_policies) Added members to member space limit exception list
MemberSpaceLimitsAddExceptionType
description String
member_space_limits_change_caps_type_policy MemberSpaceLimitsChangeCapsTypePolicyType (team_policies) Changed member space limit type for team
MemberSpaceLimitsChangeCapsTypePolicyType
description String
member_space_limits_change_policy MemberSpaceLimitsChangePolicyType (team_policies) Changed team default member space limit
MemberSpaceLimitsChangePolicyType
description String
member_space_limits_remove_exception MemberSpaceLimitsRemoveExceptionType (team_policies) Removed members from member space limit exception list
MemberSpaceLimitsRemoveExceptionType
description String
member_suggestions_change_policy MemberSuggestionsChangePolicyType (team_policies) Enabled/disabled option for team members to suggest people to add to team
MemberSuggestionsChangePolicyType
description String
microsoft_office_addin_change_policy MicrosoftOfficeAddinChangePolicyType (team_policies) Enabled/disabled Microsoft Office add-in
MicrosoftOfficeAddinChangePolicyType
description String
network_control_change_policy NetworkControlChangePolicyType (team_policies) Enabled/disabled network control
NetworkControlChangePolicyType
description String
paper_change_deployment_policy PaperChangeDeploymentPolicyType (team_policies) Changed whether Dropbox Paper, when enabled, is deployed to all members or to specific members
PaperChangeDeploymentPolicyType
description String
paper_change_member_link_policy PaperChangeMemberLinkPolicyType (team_policies) Changed whether non-members can view Paper docs with link (deprecated, no longer logged)
PaperChangeMemberLinkPolicyType
description String
paper_change_member_policy PaperChangeMemberPolicyType (team_policies) Changed whether members can share Paper docs outside team, and if docs are accessible only by team members or anyone by default
PaperChangeMemberPolicyType
description String
paper_change_policy PaperChangePolicyType (team_policies) Enabled/disabled Dropbox Paper for team
PaperChangePolicyType
description String
paper_default_folder_policy_changed PaperDefaultFolderPolicyChangedType (team_policies) Changed Paper Default Folder Policy setting for team
PaperDefaultFolderPolicyChangedType
description String
paper_desktop_policy_changed PaperDesktopPolicyChangedType (team_policies) Enabled/disabled Paper Desktop for team
PaperDesktopPolicyChangedType
description String
paper_enabled_users_group_addition PaperEnabledUsersGroupAdditionType (team_policies) Added users to Paper-enabled users list
PaperEnabledUsersGroupAdditionType
description String
paper_enabled_users_group_removal PaperEnabledUsersGroupRemovalType (team_policies) Removed users from Paper-enabled users list
PaperEnabledUsersGroupRemovalType
description String
password_strength_requirements_change_policy PasswordStrengthRequirementsChangePolicyType (team_policies) Changed team password strength requirements
PasswordStrengthRequirementsChangePolicyType
description String
permanent_delete_change_policy PermanentDeleteChangePolicyType (team_policies) Enabled/disabled ability of team members to permanently delete content
PermanentDeleteChangePolicyType
description String
reseller_support_change_policy ResellerSupportChangePolicyType (team_policies) Enabled/disabled reseller support
ResellerSupportChangePolicyType
description String
sharing_change_folder_join_policy SharingChangeFolderJoinPolicyType (team_policies) Changed whether team members can join shared folders owned outside team
SharingChangeFolderJoinPolicyType
description String
sharing_change_link_policy SharingChangeLinkPolicyType (team_policies) Changed whether members can share links outside team, and if links are accessible only by team members or anyone by default
SharingChangeLinkPolicyType
description String
sharing_change_member_policy SharingChangeMemberPolicyType (team_policies) Changed whether members can share files/folders outside team
SharingChangeMemberPolicyType
description String
showcase_change_download_policy ShowcaseChangeDownloadPolicyType (team_policies) Enabled/disabled downloading files from Dropbox Showcase for team
ShowcaseChangeDownloadPolicyType
description String
showcase_change_enabled_policy ShowcaseChangeEnabledPolicyType (team_policies) Enabled/disabled Dropbox Showcase for team
ShowcaseChangeEnabledPolicyType
description String
showcase_change_external_sharing_policy ShowcaseChangeExternalSharingPolicyType (team_policies) Enabled/disabled sharing Dropbox Showcase externally for team
ShowcaseChangeExternalSharingPolicyType
description String
smart_sync_change_policy SmartSyncChangePolicyType (team_policies) Changed default Smart Sync setting for team members
SmartSyncChangePolicyType
description String
smart_sync_not_opt_out SmartSyncNotOptOutType (team_policies) Opted team into Smart Sync
SmartSyncNotOptOutType
description String
smart_sync_opt_out SmartSyncOptOutType (team_policies) Opted team out of Smart Sync
SmartSyncOptOutType
description String
sso_change_policy SsoChangePolicyType (team_policies) Changed single sign-on setting for team
SsoChangePolicyType
description String
team_extensions_policy_changed TeamExtensionsPolicyChangedType (team_policies) Changed App Integrations setting for team
TeamExtensionsPolicyChangedType
description String
team_selective_sync_policy_changed TeamSelectiveSyncPolicyChangedType (team_policies) Enabled/disabled Team Selective Sync for team
TeamSelectiveSyncPolicyChangedType
description String
tfa_add_exception TfaAddExceptionType (team_policies) Added members to two factor authentication exception list
TfaAddExceptionType
description String
tfa_change_policy TfaChangePolicyType (team_policies) Changed two-step verification setting for team
TfaChangePolicyType
description String
tfa_remove_exception TfaRemoveExceptionType (team_policies) Removed members from two factor authentication exception list
TfaRemoveExceptionType
description String
two_account_change_policy TwoAccountChangePolicyType (team_policies) Enabled/disabled option for members to link personal Dropbox account and team account to same computer
TwoAccountChangePolicyType
description String
viewer_info_policy_changed ViewerInfoPolicyChangedType (team_policies) Changed team policy for viewer info
ViewerInfoPolicyChangedType
description String
watermarking_policy_changed WatermarkingPolicyChangedType (team_policies) Changed watermarking policy for team
WatermarkingPolicyChangedType
description String
web_sessions_change_fixed_length_policy WebSessionsChangeFixedLengthPolicyType (team_policies) Changed how long members can stay signed in to Dropbox.com
WebSessionsChangeFixedLengthPolicyType
description String
web_sessions_change_idle_length_policy WebSessionsChangeIdleLengthPolicyType (team_policies) Changed how long team members can be idle while signed in to Dropbox.com
WebSessionsChangeIdleLengthPolicyType
description String
team_merge_from TeamMergeFromType (team_profile) Merged another team into this team
TeamMergeFromType
description String
team_merge_to TeamMergeToType (team_profile) Merged this team into another team
TeamMergeToType
description String
team_profile_add_logo TeamProfileAddLogoType (team_profile) Added team logo to display on shared link headers
TeamProfileAddLogoType
description String
team_profile_change_default_language TeamProfileChangeDefaultLanguageType (team_profile) Changed default language for team
TeamProfileChangeDefaultLanguageType
description String
team_profile_change_logo TeamProfileChangeLogoType (team_profile) Changed team logo displayed on shared link headers
TeamProfileChangeLogoType
description String
team_profile_change_name TeamProfileChangeNameType (team_profile) Changed team name
TeamProfileChangeNameType
description String
team_profile_remove_logo TeamProfileRemoveLogoType (team_profile) Removed team logo displayed on shared link headers
TeamProfileRemoveLogoType
description String
tfa_add_backup_phone TfaAddBackupPhoneType (tfa) Added backup phone for two-step verification
TfaAddBackupPhoneType
description String
tfa_add_security_key TfaAddSecurityKeyType (tfa) Added security key for two-step verification
TfaAddSecurityKeyType
description String
tfa_change_backup_phone TfaChangeBackupPhoneType (tfa) Changed backup phone for two-step verification
TfaChangeBackupPhoneType
description String
tfa_change_status TfaChangeStatusType (tfa) Enabled/disabled/changed two-step verification setting
TfaChangeStatusType
description String
tfa_remove_backup_phone TfaRemoveBackupPhoneType (tfa) Removed backup phone for two-step verification
TfaRemoveBackupPhoneType
description String
tfa_remove_security_key TfaRemoveSecurityKeyType (tfa) Removed security key for two-step verification
TfaRemoveSecurityKeyType
description String
tfa_reset TfaResetType (tfa) Reset two-step verification for team member
TfaResetType
description String
changed_enterprise_admin_role ChangedEnterpriseAdminRoleType (trusted_teams) Changed enterprise admin role
ChangedEnterpriseAdminRoleType
description String
changed_enterprise_connected_team_status ChangedEnterpriseConnectedTeamStatusType (trusted_teams) Changed enterprise-connected team status
ChangedEnterpriseConnectedTeamStatusType
description String
ended_enterprise_admin_session EndedEnterpriseAdminSessionType (trusted_teams) Ended enterprise admin session
EndedEnterpriseAdminSessionType
description String
guest_admin_change_status GuestAdminChangeStatusType (trusted_teams) Changed guest team admin status
GuestAdminChangeStatusType
description String
started_enterprise_admin_session StartedEnterpriseAdminSessionType (trusted_teams) Started enterprise admin session
StartedEnterpriseAdminSessionType
description String
team_merge_request_accepted TeamMergeRequestAcceptedType (trusted_teams) Accepted a team merge request
TeamMergeRequestAcceptedType
description String
team_merge_request_accepted_shown_to_primary_team TeamMergeRequestAcceptedShownToPrimaryTeamType (trusted_teams) Accepted a team merge request (deprecated, replaced by 'Accepted a team merge request')
TeamMergeRequestAcceptedShownToPrimaryTeamType
description String
team_merge_request_accepted_shown_to_secondary_team TeamMergeRequestAcceptedShownToSecondaryTeamType (trusted_teams) Accepted a team merge request (deprecated, replaced by 'Accepted a team merge request')
TeamMergeRequestAcceptedShownToSecondaryTeamType
description String
team_merge_request_auto_canceled TeamMergeRequestAutoCanceledType (trusted_teams) Automatically canceled team merge request
TeamMergeRequestAutoCanceledType
description String
team_merge_request_canceled TeamMergeRequestCanceledType (trusted_teams) Canceled a team merge request
TeamMergeRequestCanceledType
description String
team_merge_request_canceled_shown_to_primary_team TeamMergeRequestCanceledShownToPrimaryTeamType (trusted_teams) Canceled a team merge request (deprecated, replaced by 'Canceled a team merge request')
TeamMergeRequestCanceledShownToPrimaryTeamType
description String
team_merge_request_canceled_shown_to_secondary_team TeamMergeRequestCanceledShownToSecondaryTeamType (trusted_teams) Canceled a team merge request (deprecated, replaced by 'Canceled a team merge request')
TeamMergeRequestCanceledShownToSecondaryTeamType
description String
team_merge_request_expired TeamMergeRequestExpiredType (trusted_teams) Team merge request expired
TeamMergeRequestExpiredType
description String
team_merge_request_expired_shown_to_primary_team TeamMergeRequestExpiredShownToPrimaryTeamType (trusted_teams) Team merge request expired (deprecated, replaced by 'Team merge request expired')
TeamMergeRequestExpiredShownToPrimaryTeamType
description String
team_merge_request_expired_shown_to_secondary_team TeamMergeRequestExpiredShownToSecondaryTeamType (trusted_teams) Team merge request expired (deprecated, replaced by 'Team merge request expired')
TeamMergeRequestExpiredShownToSecondaryTeamType
description String
team_merge_request_rejected_shown_to_primary_team TeamMergeRequestRejectedShownToPrimaryTeamType (trusted_teams) Rejected a team merge request (deprecated, no longer logged)
TeamMergeRequestRejectedShownToPrimaryTeamType
description String
team_merge_request_rejected_shown_to_secondary_team TeamMergeRequestRejectedShownToSecondaryTeamType (trusted_teams) Rejected a team merge request (deprecated, no longer logged)
TeamMergeRequestRejectedShownToSecondaryTeamType
description String
team_merge_request_reminder TeamMergeRequestReminderType (trusted_teams) Sent a team merge request reminder
TeamMergeRequestReminderType
description String
team_merge_request_reminder_shown_to_primary_team TeamMergeRequestReminderShownToPrimaryTeamType (trusted_teams) Sent a team merge request reminder (deprecated, replaced by 'Sent a team merge request reminder')
TeamMergeRequestReminderShownToPrimaryTeamType
description String
team_merge_request_reminder_shown_to_secondary_team TeamMergeRequestReminderShownToSecondaryTeamType (trusted_teams) Sent a team merge request reminder (deprecated, replaced by 'Sent a team merge request reminder')
TeamMergeRequestReminderShownToSecondaryTeamType
description String
team_merge_request_revoked TeamMergeRequestRevokedType (trusted_teams) Canceled the team merge
TeamMergeRequestRevokedType
description String
team_merge_request_sent_shown_to_primary_team TeamMergeRequestSentShownToPrimaryTeamType (trusted_teams) Requested to merge their Dropbox team into yours
TeamMergeRequestSentShownToPrimaryTeamType
description String
team_merge_request_sent_shown_to_secondary_team TeamMergeRequestSentShownToSecondaryTeamType (trusted_teams) Requested to merge your team into another Dropbox team
TeamMergeRequestSentShownToSecondaryTeamType
description String
details EventDetails The variable event schema applicable to this type of action, instantiated with respect to this particular action.
EventDetails (open union)
Additional fields depending on the event type. The value will be one of the following datatypes. New values may be introduced as our API evolves.
app_link_team_details AppLinkTeamDetails
AppLinkTeamDetails
Linked app for team.
app_info AppLogInfo Relevant application details.
AppLogInfo (datatype with subtypes)
App's logged information. This datatype will be one of the following subtypes:
user_or_team_linked_app UserOrTeamLinkedAppLogInfo
UserOrTeamLinkedAppLogInfo
User or team linked app. Used when linked type is missing due to historical data gap.
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
user_linked_app UserLinkedAppLogInfo
UserLinkedAppLogInfo
User linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
team_linked_app TeamLinkedAppLogInfo
TeamLinkedAppLogInfo
Team linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
app_link_user_details AppLinkUserDetails
AppLinkUserDetails
Linked app for member.
app_info AppLogInfo Relevant application details.
AppLogInfo (datatype with subtypes)
App's logged information. This datatype will be one of the following subtypes:
user_or_team_linked_app UserOrTeamLinkedAppLogInfo
UserOrTeamLinkedAppLogInfo
User or team linked app. Used when linked type is missing due to historical data gap.
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
user_linked_app UserLinkedAppLogInfo
UserLinkedAppLogInfo
User linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
team_linked_app TeamLinkedAppLogInfo
TeamLinkedAppLogInfo
Team linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
app_unlink_team_details AppUnlinkTeamDetails
AppUnlinkTeamDetails
Unlinked app for team.
app_info AppLogInfo Relevant application details.
AppLogInfo (datatype with subtypes)
App's logged information. This datatype will be one of the following subtypes:
user_or_team_linked_app UserOrTeamLinkedAppLogInfo
UserOrTeamLinkedAppLogInfo
User or team linked app. Used when linked type is missing due to historical data gap.
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
user_linked_app UserLinkedAppLogInfo
UserLinkedAppLogInfo
User linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
team_linked_app TeamLinkedAppLogInfo
TeamLinkedAppLogInfo
Team linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
app_unlink_user_details AppUnlinkUserDetails
AppUnlinkUserDetails
Unlinked app for member.
app_info AppLogInfo Relevant application details.
AppLogInfo (datatype with subtypes)
App's logged information. This datatype will be one of the following subtypes:
user_or_team_linked_app UserOrTeamLinkedAppLogInfo
UserOrTeamLinkedAppLogInfo
User or team linked app. Used when linked type is missing due to historical data gap.
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
user_linked_app UserLinkedAppLogInfo
UserLinkedAppLogInfo
User linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
team_linked_app TeamLinkedAppLogInfo
TeamLinkedAppLogInfo
Team linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
integration_connected_details IntegrationConnectedDetails
IntegrationConnectedDetails
Connected integration for member.
integration_name String Name of the third-party integration.
integration_disconnected_details IntegrationDisconnectedDetails
IntegrationDisconnectedDetails
Disconnected integration for member.
integration_name String Name of the third-party integration.
file_add_comment_details FileAddCommentDetails
FileAddCommentDetails
Added file comment.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_change_comment_subscription_details FileChangeCommentSubscriptionDetails
FileChangeCommentSubscriptionDetails
Subscribed to or unsubscribed from comment notifications for file.
new_value FileCommentNotificationPolicy New file comment subscription.
FileCommentNotificationPolicy (open union)
Enable or disable file comments notifications The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value FileCommentNotificationPolicy? Previous file comment subscription. Might be missing due to historical data gap. This field is optional.
FileCommentNotificationPolicy (open union)
Enable or disable file comments notifications The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
file_delete_comment_details FileDeleteCommentDetails
FileDeleteCommentDetails
Deleted file comment.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_edit_comment_details FileEditCommentDetails
FileEditCommentDetails
Edited file comment.
previous_comment_text String Previous comment text.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_like_comment_details FileLikeCommentDetails
FileLikeCommentDetails
Liked file comment.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_resolve_comment_details FileResolveCommentDetails
FileResolveCommentDetails
Resolved file comment.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_unlike_comment_details FileUnlikeCommentDetails
FileUnlikeCommentDetails
Unliked file comment.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_unresolve_comment_details FileUnresolveCommentDetails
FileUnresolveCommentDetails
Unresolved file comment.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
device_change_ip_desktop_details DeviceChangeIpDesktopDetails
DeviceChangeIpDesktopDetails
Changed IP address associated with active desktop session.
device_session_info DeviceSessionLogInfo Device's session logged information.
DeviceSessionLogInfo (datatype with subtypes)
Device's session logged information. This datatype will be one of the following subtypes:
desktop_device_session DesktopDeviceSessionLogInfo
DesktopDeviceSessionLogInfo
Information about linked Dropbox desktop client sessions
host_name String Name of the hosting desktop.
client_type DesktopPlatform The Dropbox desktop client type.
DesktopPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
windows Void Official Windows Dropbox desktop client.
mac Void Official Mac Dropbox desktop client.
linux Void Official Linux Dropbox desktop client.
platform String Information on the hosting platform.
is_delete_on_unlink_supported Boolean Whether itu2019s possible to delete all of the account files upon unlinking.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info DesktopSessionLogInfo? Desktop session unique id. Might be missing due to historical data gap. This field is optional.
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
mobile_device_session MobileDeviceSessionLogInfo
MobileDeviceSessionLogInfo
Information about linked Dropbox mobile client sessions
device_name String The device name.
client_type MobileClientPlatform The mobile application type.
MobileClientPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
iphone Void Official Dropbox iPhone client.
ipad Void Official Dropbox iPad client.
android Void Official Dropbox Android client.
windows_phone Void Official Dropbox Windows phone client.
blackberry Void Official Dropbox Blackberry client.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info MobileSessionLogInfo? Mobile session unique id. Might be missing due to historical data gap. This field is optional.
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
os_version String? The hosting OS version. This field is optional.
last_carrier String? last carrier used by the device. This field is optional.
web_device_session WebDeviceSessionLogInfo
WebDeviceSessionLogInfo
Information on active web sessions
user_agent String Information on the hosting device.
os String Information on the hosting operating system.
browser String Information on the browser used for this web session.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info WebSessionLogInfo? Web session unique id. Might be missing due to historical data gap. This field is optional.
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
legacy_device_session LegacyDeviceSessionLogInfo
LegacyDeviceSessionLogInfo
Information on sessions, in legacy format
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info SessionLogInfo? Session unique id. Might be missing due to historical data gap. This field is optional.
SessionLogInfo (datatype with subtypes)
Session's logged information. This datatype will be one of the following subtypes:
web WebSessionLogInfo
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
desktop DesktopSessionLogInfo
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
mobile MobileSessionLogInfo
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
display_name String? The device name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? Is device managed by emm. Might be missing due to historical data gap. This field is optional.
platform String? Information on the hosting platform. Might be missing due to historical data gap. This field is optional.
mac_address String? The mac address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
os_version String? The hosting OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Information on the hosting device type. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. Might be missing due to historical data gap. This field is optional.
legacy_uniq_id String? Alternative unique device session id, instead of session id field. Might be missing due to historical data gap. This field is optional.
device_change_ip_mobile_details DeviceChangeIpMobileDetails
DeviceChangeIpMobileDetails
Changed IP address associated with active mobile session.
device_session_info DeviceSessionLogInfo? Device's session logged information. This field is optional.
DeviceSessionLogInfo (datatype with subtypes)
Device's session logged information. This datatype will be one of the following subtypes:
desktop_device_session DesktopDeviceSessionLogInfo
DesktopDeviceSessionLogInfo
Information about linked Dropbox desktop client sessions
host_name String Name of the hosting desktop.
client_type DesktopPlatform The Dropbox desktop client type.
DesktopPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
windows Void Official Windows Dropbox desktop client.
mac Void Official Mac Dropbox desktop client.
linux Void Official Linux Dropbox desktop client.
platform String Information on the hosting platform.
is_delete_on_unlink_supported Boolean Whether itu2019s possible to delete all of the account files upon unlinking.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info DesktopSessionLogInfo? Desktop session unique id. Might be missing due to historical data gap. This field is optional.
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
mobile_device_session MobileDeviceSessionLogInfo
MobileDeviceSessionLogInfo
Information about linked Dropbox mobile client sessions
device_name String The device name.
client_type MobileClientPlatform The mobile application type.
MobileClientPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
iphone Void Official Dropbox iPhone client.
ipad Void Official Dropbox iPad client.
android Void Official Dropbox Android client.
windows_phone Void Official Dropbox Windows phone client.
blackberry Void Official Dropbox Blackberry client.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info MobileSessionLogInfo? Mobile session unique id. Might be missing due to historical data gap. This field is optional.
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
os_version String? The hosting OS version. This field is optional.
last_carrier String? last carrier used by the device. This field is optional.
web_device_session WebDeviceSessionLogInfo
WebDeviceSessionLogInfo
Information on active web sessions
user_agent String Information on the hosting device.
os String Information on the hosting operating system.
browser String Information on the browser used for this web session.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info WebSessionLogInfo? Web session unique id. Might be missing due to historical data gap. This field is optional.
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
legacy_device_session LegacyDeviceSessionLogInfo
LegacyDeviceSessionLogInfo
Information on sessions, in legacy format
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info SessionLogInfo? Session unique id. Might be missing due to historical data gap. This field is optional.
SessionLogInfo (datatype with subtypes)
Session's logged information. This datatype will be one of the following subtypes:
web WebSessionLogInfo
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
desktop DesktopSessionLogInfo
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
mobile MobileSessionLogInfo
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
display_name String? The device name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? Is device managed by emm. Might be missing due to historical data gap. This field is optional.
platform String? Information on the hosting platform. Might be missing due to historical data gap. This field is optional.
mac_address String? The mac address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
os_version String? The hosting OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Information on the hosting device type. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. Might be missing due to historical data gap. This field is optional.
legacy_uniq_id String? Alternative unique device session id, instead of session id field. Might be missing due to historical data gap. This field is optional.
device_change_ip_web_details DeviceChangeIpWebDetails
DeviceChangeIpWebDetails
Changed IP address associated with active web session.
user_agent String Web browser name.
device_delete_on_unlink_fail_details DeviceDeleteOnUnlinkFailDetails
DeviceDeleteOnUnlinkFailDetails
Failed to delete all files from unlinked device.
num_failures Int64 The number of times that remote file deletion failed.
session_info SessionLogInfo? Session unique id. Might be missing due to historical data gap. This field is optional.
SessionLogInfo (datatype with subtypes)
Session's logged information. This datatype will be one of the following subtypes:
web WebSessionLogInfo
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
desktop DesktopSessionLogInfo
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
mobile MobileSessionLogInfo
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
display_name String? The device name. Might be missing due to historical data gap. This field is optional.
device_delete_on_unlink_success_details DeviceDeleteOnUnlinkSuccessDetails
DeviceDeleteOnUnlinkSuccessDetails
Deleted all files from unlinked device.
session_info SessionLogInfo? Session unique id. Might be missing due to historical data gap. This field is optional.
SessionLogInfo (datatype with subtypes)
Session's logged information. This datatype will be one of the following subtypes:
web WebSessionLogInfo
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
desktop DesktopSessionLogInfo
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
mobile MobileSessionLogInfo
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
display_name String? The device name. Might be missing due to historical data gap. This field is optional.
device_link_fail_details DeviceLinkFailDetails
DeviceLinkFailDetails
Failed to link device.
device_type DeviceType A description of the device used while user approval blocked.
DeviceType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
desktop Void
mobile Void
ip_address String? IP address. Might be missing due to historical data gap. This field is optional.
device_link_success_details DeviceLinkSuccessDetails
DeviceLinkSuccessDetails
Linked device.
device_session_info DeviceSessionLogInfo? Device's session logged information. This field is optional.
DeviceSessionLogInfo (datatype with subtypes)
Device's session logged information. This datatype will be one of the following subtypes:
desktop_device_session DesktopDeviceSessionLogInfo
DesktopDeviceSessionLogInfo
Information about linked Dropbox desktop client sessions
host_name String Name of the hosting desktop.
client_type DesktopPlatform The Dropbox desktop client type.
DesktopPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
windows Void Official Windows Dropbox desktop client.
mac Void Official Mac Dropbox desktop client.
linux Void Official Linux Dropbox desktop client.
platform String Information on the hosting platform.
is_delete_on_unlink_supported Boolean Whether itu2019s possible to delete all of the account files upon unlinking.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info DesktopSessionLogInfo? Desktop session unique id. Might be missing due to historical data gap. This field is optional.
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
mobile_device_session MobileDeviceSessionLogInfo
MobileDeviceSessionLogInfo
Information about linked Dropbox mobile client sessions
device_name String The device name.
client_type MobileClientPlatform The mobile application type.
MobileClientPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
iphone Void Official Dropbox iPhone client.
ipad Void Official Dropbox iPad client.
android Void Official Dropbox Android client.
windows_phone Void Official Dropbox Windows phone client.
blackberry Void Official Dropbox Blackberry client.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info MobileSessionLogInfo? Mobile session unique id. Might be missing due to historical data gap. This field is optional.
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
os_version String? The hosting OS version. This field is optional.
last_carrier String? last carrier used by the device. This field is optional.
web_device_session WebDeviceSessionLogInfo
WebDeviceSessionLogInfo
Information on active web sessions
user_agent String Information on the hosting device.
os String Information on the hosting operating system.
browser String Information on the browser used for this web session.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info WebSessionLogInfo? Web session unique id. Might be missing due to historical data gap. This field is optional.
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
legacy_device_session LegacyDeviceSessionLogInfo
LegacyDeviceSessionLogInfo
Information on sessions, in legacy format
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info SessionLogInfo? Session unique id. Might be missing due to historical data gap. This field is optional.
SessionLogInfo (datatype with subtypes)
Session's logged information. This datatype will be one of the following subtypes:
web WebSessionLogInfo
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
desktop DesktopSessionLogInfo
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
mobile MobileSessionLogInfo
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
display_name String? The device name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? Is device managed by emm. Might be missing due to historical data gap. This field is optional.
platform String? Information on the hosting platform. Might be missing due to historical data gap. This field is optional.
mac_address String? The mac address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
os_version String? The hosting OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Information on the hosting device type. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. Might be missing due to historical data gap. This field is optional.
legacy_uniq_id String? Alternative unique device session id, instead of session id field. Might be missing due to historical data gap. This field is optional.
device_management_disabled_details DeviceManagementDisabledDetails
DeviceManagementDisabledDetails
Disabled device management.
device_management_enabled_details DeviceManagementEnabledDetails
DeviceManagementEnabledDetails
Enabled device management.
device_unlink_details DeviceUnlinkDetails
DeviceUnlinkDetails
Disconnected device.
delete_data Boolean True if the user requested to delete data after device unlink, false otherwise.
session_info SessionLogInfo? Session unique id. This field is optional.
SessionLogInfo (datatype with subtypes)
Session's logged information. This datatype will be one of the following subtypes:
web WebSessionLogInfo
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
desktop DesktopSessionLogInfo
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
mobile MobileSessionLogInfo
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
display_name String? The device name. Might be missing due to historical data gap. This field is optional.
emm_refresh_auth_token_details EmmRefreshAuthTokenDetails
EmmRefreshAuthTokenDetails
Refreshed auth token used for setting up EMM.
account_capture_change_availability_details AccountCaptureChangeAvailabilityDetails
AccountCaptureChangeAvailabilityDetails
Granted/revoked option to enable account capture on team domains.
new_value AccountCaptureAvailability New account capture availabilty value.
AccountCaptureAvailability (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
unavailable Void
available Void
previous_value AccountCaptureAvailability? Previous account capture availabilty value. Might be missing due to historical data gap. This field is optional.
AccountCaptureAvailability (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
unavailable Void
available Void
account_capture_migrate_account_details AccountCaptureMigrateAccountDetails
AccountCaptureMigrateAccountDetails
Account-captured user migrated account to team.
domain_name String Domain name.
account_capture_notification_emails_sent_details AccountCaptureNotificationEmailsSentDetails
AccountCaptureNotificationEmailsSentDetails
Sent proactive account capture email to all unmanaged members.
domain_name String Domain name.
account_capture_relinquish_account_details AccountCaptureRelinquishAccountDetails
AccountCaptureRelinquishAccountDetails
Account-captured user changed account email to personal email.
domain_name String Domain name.
disabled_domain_invites_details DisabledDomainInvitesDetails
DisabledDomainInvitesDetails
Disabled domain invites.
domain_invites_approve_request_to_join_team_details DomainInvitesApproveRequestToJoinTeamDetails
DomainInvitesApproveRequestToJoinTeamDetails
Approved user's request to join team.
domain_invites_decline_request_to_join_team_details DomainInvitesDeclineRequestToJoinTeamDetails
DomainInvitesDeclineRequestToJoinTeamDetails
Declined user's request to join team.
domain_invites_email_existing_users_details DomainInvitesEmailExistingUsersDetails
DomainInvitesEmailExistingUsersDetails
Sent domain invites to existing domain accounts.
domain_name String Domain names.
num_recipients UInt64 Number of recipients.
domain_invites_request_to_join_team_details DomainInvitesRequestToJoinTeamDetails
DomainInvitesRequestToJoinTeamDetails
Requested to join team.
domain_invites_set_invite_new_user_pref_to_no_details DomainInvitesSetInviteNewUserPrefToNoDetails
DomainInvitesSetInviteNewUserPrefToNoDetails
Disabled "Automatically invite new users".
domain_invites_set_invite_new_user_pref_to_yes_details DomainInvitesSetInviteNewUserPrefToYesDetails
DomainInvitesSetInviteNewUserPrefToYesDetails
Enabled "Automatically invite new users".
domain_verification_add_domain_fail_details DomainVerificationAddDomainFailDetails
DomainVerificationAddDomainFailDetails
Failed to verify team domain.
domain_name String Domain name.
verification_method String? Domain name verification method. Might be missing due to historical data gap. This field is optional.
domain_verification_add_domain_success_details DomainVerificationAddDomainSuccessDetails
DomainVerificationAddDomainSuccessDetails
Verified team domain.
domain_names List of (String) Domain names.
verification_method String? Domain name verification method. Might be missing due to historical data gap. This field is optional.
domain_verification_remove_domain_details DomainVerificationRemoveDomainDetails
DomainVerificationRemoveDomainDetails
Removed domain from list of verified team domains.
domain_names List of (String) Domain names.
enabled_domain_invites_details EnabledDomainInvitesDetails
EnabledDomainInvitesDetails
Enabled domain invites.
create_folder_details CreateFolderDetails
CreateFolderDetails
Created folders.
file_add_details FileAddDetails
FileAddDetails
Added files and/or folders.
file_copy_details FileCopyDetails
FileCopyDetails
Copied files and/or folders.
relocate_action_details List of (RelocateAssetReferencesLogInfo) Relocate action details.
RelocateAssetReferencesLogInfo
Provides the indices of the source asset and the destination asset for a relocate action.
src_asset_index UInt64 Source asset position in the Assets list.
dest_asset_index UInt64 Destination asset position in the Assets list.
file_delete_details FileDeleteDetails
FileDeleteDetails
Deleted files and/or folders.
file_download_details FileDownloadDetails
FileDownloadDetails
Downloaded files and/or folders.
file_edit_details FileEditDetails
FileEditDetails
Edited files.
file_get_copy_reference_details FileGetCopyReferenceDetails
FileGetCopyReferenceDetails
Created copy reference to file/folder.
file_move_details FileMoveDetails
FileMoveDetails
Moved files and/or folders.
relocate_action_details List of (RelocateAssetReferencesLogInfo) Relocate action details.
RelocateAssetReferencesLogInfo
Provides the indices of the source asset and the destination asset for a relocate action.
src_asset_index UInt64 Source asset position in the Assets list.
dest_asset_index UInt64 Destination asset position in the Assets list.
file_permanently_delete_details FilePermanentlyDeleteDetails
FilePermanentlyDeleteDetails
Permanently deleted files and/or folders.
file_preview_details FilePreviewDetails
FilePreviewDetails
Previewed files and/or folders.
file_rename_details FileRenameDetails
FileRenameDetails
Renamed files and/or folders.
relocate_action_details List of (RelocateAssetReferencesLogInfo) Relocate action details.
RelocateAssetReferencesLogInfo
Provides the indices of the source asset and the destination asset for a relocate action.
src_asset_index UInt64 Source asset position in the Assets list.
dest_asset_index UInt64 Destination asset position in the Assets list.
file_restore_details FileRestoreDetails
FileRestoreDetails
Restored deleted files and/or folders.
file_revert_details FileRevertDetails
FileRevertDetails
Reverted files to previous version.
file_rollback_changes_details FileRollbackChangesDetails
FileRollbackChangesDetails
Rolled back file actions.
file_save_copy_reference_details FileSaveCopyReferenceDetails
FileSaveCopyReferenceDetails
Saved file/folder using copy reference.
relocate_action_details List of (RelocateAssetReferencesLogInfo) Relocate action details.
RelocateAssetReferencesLogInfo
Provides the indices of the source asset and the destination asset for a relocate action.
src_asset_index UInt64 Source asset position in the Assets list.
dest_asset_index UInt64 Destination asset position in the Assets list.
folder_overview_description_changed_details FolderOverviewDescriptionChangedDetails
FolderOverviewDescriptionChangedDetails
Updated folder overview.
folder_overview_location_asset UInt64 Folder Overview location position in the Assets list.
folder_overview_item_pinned_details FolderOverviewItemPinnedDetails
FolderOverviewItemPinnedDetails
Pinned item to folder overview.
folder_overview_location_asset UInt64 Folder Overview location position in the Assets list.
pinned_items_asset_indices List of (UInt64) Pinned items positions in the Assets list.
folder_overview_item_unpinned_details FolderOverviewItemUnpinnedDetails
FolderOverviewItemUnpinnedDetails
Unpinned item from folder overview.
folder_overview_location_asset UInt64 Folder Overview location position in the Assets list.
pinned_items_asset_indices List of (UInt64) Pinned items positions in the Assets list.
file_request_change_details FileRequestChangeDetails
FileRequestChangeDetails
Changed file request.
new_details FileRequestDetails New file request details.
FileRequestDetails
File request details
asset_index UInt64 Asset position in the Assets list.
deadline FileRequestDeadline? File request deadline. Might be missing due to historical data gap. This field is optional.
FileRequestDeadline
File request deadline
deadline Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The deadline for this file request. Might be missing due to historical data gap. This field is optional.
allow_late_uploads String? If set, allow uploads after the deadline has passed. Might be missing due to historical data gap. This field is optional.
file_request_id String(min_length=1, pattern="[-_0-9a-zA-Z]+")? File request id. Might be missing due to historical data gap. This field is optional.
previous_details FileRequestDetails? Previous file request details. Might be missing due to historical data gap. This field is optional.
FileRequestDetails
File request details
asset_index UInt64 Asset position in the Assets list.
deadline FileRequestDeadline? File request deadline. Might be missing due to historical data gap. This field is optional.
FileRequestDeadline
File request deadline
deadline Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The deadline for this file request. Might be missing due to historical data gap. This field is optional.
allow_late_uploads String? If set, allow uploads after the deadline has passed. Might be missing due to historical data gap. This field is optional.
file_request_close_details FileRequestCloseDetails
FileRequestCloseDetails
Closed file request.
file_request_id String(min_length=1, pattern="[-_0-9a-zA-Z]+")? File request id. Might be missing due to historical data gap. This field is optional.
previous_details FileRequestDetails? Previous file request details. Might be missing due to historical data gap. This field is optional.
FileRequestDetails
File request details
asset_index UInt64 Asset position in the Assets list.
deadline FileRequestDeadline? File request deadline. Might be missing due to historical data gap. This field is optional.
FileRequestDeadline
File request deadline
deadline Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The deadline for this file request. Might be missing due to historical data gap. This field is optional.
allow_late_uploads String? If set, allow uploads after the deadline has passed. Might be missing due to historical data gap. This field is optional.
file_request_create_details FileRequestCreateDetails
FileRequestCreateDetails
Created file request.
file_request_id String(min_length=1, pattern="[-_0-9a-zA-Z]+")? File request id. Might be missing due to historical data gap. This field is optional.
request_details FileRequestDetails? File request details. Might be missing due to historical data gap. This field is optional.
FileRequestDetails
File request details
asset_index UInt64 Asset position in the Assets list.
deadline FileRequestDeadline? File request deadline. Might be missing due to historical data gap. This field is optional.
FileRequestDeadline
File request deadline
deadline Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The deadline for this file request. Might be missing due to historical data gap. This field is optional.
allow_late_uploads String? If set, allow uploads after the deadline has passed. Might be missing due to historical data gap. This field is optional.
file_request_delete_details FileRequestDeleteDetails
FileRequestDeleteDetails
Delete file request.
file_request_id String(min_length=1, pattern="[-_0-9a-zA-Z]+")? File request id. Might be missing due to historical data gap. This field is optional.
previous_details FileRequestDetails? Previous file request details. Might be missing due to historical data gap. This field is optional.
FileRequestDetails
File request details
asset_index UInt64 Asset position in the Assets list.
deadline FileRequestDeadline? File request deadline. Might be missing due to historical data gap. This field is optional.
FileRequestDeadline
File request deadline
deadline Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The deadline for this file request. Might be missing due to historical data gap. This field is optional.
allow_late_uploads String? If set, allow uploads after the deadline has passed. Might be missing due to historical data gap. This field is optional.
file_request_receive_file_details FileRequestReceiveFileDetails
FileRequestReceiveFileDetails
Received files for file request.
submitted_file_names List of (String) Submitted file names.
file_request_id String(min_length=1, pattern="[-_0-9a-zA-Z]+")? File request id. Might be missing due to historical data gap. This field is optional.
file_request_details FileRequestDetails? File request details. Might be missing due to historical data gap. This field is optional.
FileRequestDetails
File request details
asset_index UInt64 Asset position in the Assets list.
deadline FileRequestDeadline? File request deadline. Might be missing due to historical data gap. This field is optional.
FileRequestDeadline
File request deadline
deadline Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The deadline for this file request. Might be missing due to historical data gap. This field is optional.
allow_late_uploads String? If set, allow uploads after the deadline has passed. Might be missing due to historical data gap. This field is optional.
submitter_name String? The name as provided by the submitter. Might be missing due to historical data gap. This field is optional.
submitter_email String(max_length=255)? The email as provided by the submitter. Might be missing due to historical data gap. This field is optional.
group_add_external_id_details GroupAddExternalIdDetails
GroupAddExternalIdDetails
Added external ID for group.
new_value String Current external id.
group_add_member_details GroupAddMemberDetails
GroupAddMemberDetails
Added team members to group.
is_group_owner Boolean Is group owner.
group_change_external_id_details GroupChangeExternalIdDetails
GroupChangeExternalIdDetails
Changed external ID for group.
new_value String Current external id.
previous_value String Old external id.
group_change_management_type_details GroupChangeManagementTypeDetails
GroupChangeManagementTypeDetails
Changed group management type.
new_value GroupManagementType New group management type.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
previous_value GroupManagementType? Previous group management type. Might be missing due to historical data gap. This field is optional.
GroupManagementType (open union)
The group type determines how a group is managed. This datatype comes from an imported namespace originally defined in the team_common namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user_managed Void A group which is managed by selected users.
company_managed Void A group which is managed by team admins only.
system_managed Void A group which is managed automatically by Dropbox.
group_change_member_role_details GroupChangeMemberRoleDetails
GroupChangeMemberRoleDetails
Changed manager permissions of group member.
is_group_owner Boolean Is group owner.
group_create_details GroupCreateDetails
GroupCreateDetails
Created group.
is_company_managed Boolean? Is company managed group. Might be missing due to historical data gap. This field is optional.
join_policy GroupJoinPolicy? Group join policy. This field is optional.
GroupJoinPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
open Void
request_to_join Void
group_delete_details GroupDeleteDetails
GroupDeleteDetails
Deleted group.
is_company_managed Boolean? Is company managed group. Might be missing due to historical data gap. This field is optional.
group_description_updated_details GroupDescriptionUpdatedDetails
GroupDescriptionUpdatedDetails
Updated group.
group_join_policy_updated_details GroupJoinPolicyUpdatedDetails
GroupJoinPolicyUpdatedDetails
Updated group join policy.
is_company_managed Boolean? Is company managed group. Might be missing due to historical data gap. This field is optional.
join_policy GroupJoinPolicy? Group join policy. This field is optional.
GroupJoinPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
open Void
request_to_join Void
group_moved_details GroupMovedDetails
GroupMovedDetails
Moved group.
group_remove_external_id_details GroupRemoveExternalIdDetails
GroupRemoveExternalIdDetails
Removed external ID for group.
previous_value String Old external id.
group_remove_member_details GroupRemoveMemberDetails
GroupRemoveMemberDetails
Removed team members from group.
group_rename_details GroupRenameDetails
GroupRenameDetails
Renamed group.
previous_value String Previous display name.
new_value String New display name.
legal_holds_activate_a_hold_details LegalHoldsActivateAHoldDetails
LegalHoldsActivateAHoldDetails
Activated a hold.
legal_hold_id String Hold ID.
name String Hold name.
start_date Timestamp(format="%Y-%m-%dT%H:%M:%SZ") Hold start date.
end_date Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? Hold end date. This field is optional.
legal_holds_add_members_details LegalHoldsAddMembersDetails
LegalHoldsAddMembersDetails
Added members to a hold.
legal_hold_id String Hold ID.
name String Hold name.
legal_holds_change_hold_details_details LegalHoldsChangeHoldDetailsDetails
LegalHoldsChangeHoldDetailsDetails
Edited details for a hold.
legal_hold_id String Hold ID.
name String Hold name.
previous_value String Previous details.
new_value String New details.
legal_holds_change_hold_name_details LegalHoldsChangeHoldNameDetails
LegalHoldsChangeHoldNameDetails
Renamed a hold.
legal_hold_id String Hold ID.
previous_value String Previous Name.
new_value String New Name.
legal_holds_export_a_hold_details LegalHoldsExportAHoldDetails
LegalHoldsExportAHoldDetails
Exported hold.
legal_hold_id String Hold ID.
name String Hold name.
legal_holds_release_a_hold_details LegalHoldsReleaseAHoldDetails
LegalHoldsReleaseAHoldDetails
Released a hold.
legal_hold_id String Hold ID.
name String Hold name.
legal_holds_remove_members_details LegalHoldsRemoveMembersDetails
LegalHoldsRemoveMembersDetails
Removed members from a hold.
legal_hold_id String Hold ID.
name String Hold name.
legal_holds_report_a_hold_details LegalHoldsReportAHoldDetails
LegalHoldsReportAHoldDetails
Created a summary report for a hold.
legal_hold_id String Hold ID.
name String Hold name.
emm_error_details EmmErrorDetails
EmmErrorDetails
Failed to sign in via EMM.
error_details FailureDetailsLogInfo Error details.
FailureDetailsLogInfo
Provides details about a failure
user_friendly_message String? A user friendly explanation of the error. Might be missing due to historical data gap. This field is optional.
technical_error_message String? A technical explanation of the error. This is relevant for some errors. This field is optional.
guest_admin_signed_in_via_trusted_teams_details GuestAdminSignedInViaTrustedTeamsDetails
GuestAdminSignedInViaTrustedTeamsDetails
Started trusted team admin session.
team_name String? Host team name. This field is optional.
trusted_team_name String? Trusted team name. This field is optional.
guest_admin_signed_out_via_trusted_teams_details GuestAdminSignedOutViaTrustedTeamsDetails
GuestAdminSignedOutViaTrustedTeamsDetails
Ended trusted team admin session.
team_name String? Host team name. This field is optional.
trusted_team_name String? Trusted team name. This field is optional.
login_fail_details LoginFailDetails
LoginFailDetails
Failed to sign in.
login_method LoginMethod Login method.
LoginMethod (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
password Void
two_factor_authentication Void
saml Void
google_oauth Void
web_session Void
qr_code Void
apple_oauth Void
error_details FailureDetailsLogInfo Error details.
FailureDetailsLogInfo
Provides details about a failure
user_friendly_message String? A user friendly explanation of the error. Might be missing due to historical data gap. This field is optional.
technical_error_message String? A technical explanation of the error. This is relevant for some errors. This field is optional.
is_emm_managed Boolean? Tells if the login device is EMM managed. Might be missing due to historical data gap. This field is optional.
login_success_details LoginSuccessDetails
LoginSuccessDetails
Signed in.
login_method LoginMethod Login method.
LoginMethod (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
password Void
two_factor_authentication Void
saml Void
google_oauth Void
web_session Void
qr_code Void
apple_oauth Void
is_emm_managed Boolean? Tells if the login device is EMM managed. Might be missing due to historical data gap. This field is optional.
logout_details LogoutDetails
LogoutDetails
Signed out.
reseller_support_session_end_details ResellerSupportSessionEndDetails
ResellerSupportSessionEndDetails
Ended reseller support session.
reseller_support_session_start_details ResellerSupportSessionStartDetails
ResellerSupportSessionStartDetails
Started reseller support session.
sign_in_as_session_end_details SignInAsSessionEndDetails
SignInAsSessionEndDetails
Ended admin sign-in-as session.
sign_in_as_session_start_details SignInAsSessionStartDetails
SignInAsSessionStartDetails
Started admin sign-in-as session.
sso_error_details SsoErrorDetails
SsoErrorDetails
Failed to sign in via SSO.
error_details FailureDetailsLogInfo Error details.
FailureDetailsLogInfo
Provides details about a failure
user_friendly_message String? A user friendly explanation of the error. Might be missing due to historical data gap. This field is optional.
technical_error_message String? A technical explanation of the error. This is relevant for some errors. This field is optional.
member_add_external_id_details MemberAddExternalIdDetails
MemberAddExternalIdDetails
Added an external ID for team member.
new_value String(max_length=64) Current external id.
member_add_name_details MemberAddNameDetails
MemberAddNameDetails
Added team member name.
new_value UserNameLogInfo New user's name.
UserNameLogInfo
User's name logged information
given_name String Given name.
surname String Surname.
locale String? Locale. Might be missing due to historical data gap. This field is optional.
member_change_admin_role_details MemberChangeAdminRoleDetails
MemberChangeAdminRoleDetails
Changed team member admin role.
new_value AdminRole? New admin role. This field is relevant when the admin role is changed or whenthe user role changes from no admin rights to with admin rights. This field is optional.
AdminRole (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_admin Void
user_management_admin Void
support_admin Void
limited_admin Void
member_only Void
previous_value AdminRole? Previous admin role. This field is relevant when the admin role is changed or when the admin role is removed. This field is optional.
AdminRole (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_admin Void
user_management_admin Void
support_admin Void
limited_admin Void
member_only Void
member_change_email_details MemberChangeEmailDetails
MemberChangeEmailDetails
Changed team member email.
new_value String(max_length=255) New email.
previous_value String(max_length=255)? Previous email. Might be missing due to historical data gap. This field is optional.
member_change_external_id_details MemberChangeExternalIdDetails
MemberChangeExternalIdDetails
Changed the external ID for team member.
new_value String(max_length=64) Current external id.
previous_value String(max_length=64) Old external id.
member_change_membership_type_details MemberChangeMembershipTypeDetails
MemberChangeMembershipTypeDetails
Changed membership type (limited/full) of member.
prev_value TeamMembershipType Previous membership type.
TeamMembershipType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
free Void
full Void
new_value TeamMembershipType New membership type.
TeamMembershipType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
free Void
full Void
member_change_name_details MemberChangeNameDetails
MemberChangeNameDetails
Changed team member name.
new_value UserNameLogInfo New user's name.
UserNameLogInfo
User's name logged information
given_name String Given name.
surname String Surname.
locale String? Locale. Might be missing due to historical data gap. This field is optional.
previous_value UserNameLogInfo? Previous user's name. Might be missing due to historical data gap. This field is optional.
UserNameLogInfo
User's name logged information
given_name String Given name.
surname String Surname.
locale String? Locale. Might be missing due to historical data gap. This field is optional.
member_change_status_details MemberChangeStatusDetails
MemberChangeStatusDetails
Changed member status (invited, joined, suspended, etc.).
new_value MemberStatus New member status.
MemberStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
not_joined Void
invited Void
active Void
suspended Void
removed Void
previous_value MemberStatus? Previous member status. Might be missing due to historical data gap. This field is optional.
MemberStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
not_joined Void
invited Void
active Void
suspended Void
removed Void
action ActionDetails? Additional information indicating the action taken that caused status change. This field is optional.
ActionDetails (open union)
Additional information indicating the action taken that caused status change. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_join_details JoinTeamDetails Additional information relevant when a new member joins the team.
JoinTeamDetails
Additional information relevant when a new member joins the team.
linked_appsdeprecated List of (UserLinkedAppLogInfo) Field is deprecated. Linked applications.
UserLinkedAppLogInfo
User linked app
app_id String? App unique ID. Might be missing due to historical data gap. This field is optional.
display_name String? App display name. Might be missing due to historical data gap. This field is optional.
linked_devicesdeprecated List of (LinkedDeviceLogInfo) Field is deprecated. Linked devices.
LinkedDeviceLogInfo (open union)
The device sessions that user is linked to. The value will be one of the following datatypes. New values may be introduced as our API evolves.
mobile_device_session MobileDeviceSessionLogInfo mobile device session's details.
MobileDeviceSessionLogInfo
Information about linked Dropbox mobile client sessions
device_name String The device name.
client_type MobileClientPlatform The mobile application type.
MobileClientPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
iphone Void Official Dropbox iPhone client.
ipad Void Official Dropbox iPad client.
android Void Official Dropbox Android client.
windows_phone Void Official Dropbox Windows phone client.
blackberry Void Official Dropbox Blackberry client.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info MobileSessionLogInfo? Mobile session unique id. Might be missing due to historical data gap. This field is optional.
MobileSessionLogInfo
Mobile session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
os_version String? The hosting OS version. This field is optional.
last_carrier String? last carrier used by the device. This field is optional.
desktop_device_session DesktopDeviceSessionLogInfo desktop device session's details.
DesktopDeviceSessionLogInfo
Information about linked Dropbox desktop client sessions
host_name String Name of the hosting desktop.
client_type DesktopPlatform The Dropbox desktop client type.
DesktopPlatform (open union)
This datatype comes from an imported namespace originally defined in the team namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
windows Void Official Windows Dropbox desktop client.
mac Void Official Mac Dropbox desktop client.
linux Void Official Linux Dropbox desktop client.
platform String Information on the hosting platform.
is_delete_on_unlink_supported Boolean Whether itu2019s possible to delete all of the account files upon unlinking.
ip_address String? The IP address of the last activity from this session. Might be missing due to historical data gap. This field is optional.
created Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time this session was created. Might be missing due to historical data gap. This field is optional.
updated Timestamp(format="%Y-%m-%dT%H:%M:%SZ")? The time of the last activity from this session. Might be missing due to historical data gap. This field is optional.
session_info DesktopSessionLogInfo? Desktop session unique id. Might be missing due to historical data gap. This field is optional.
DesktopSessionLogInfo
Desktop session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
client_version String? The Dropbox client version. This field is optional.
web_device_session WebDeviceSessionLogInfo web device session's details.
WebDeviceSessionLogInfo
Information on active web sessions
user_agent String Information on the hosting device.