Dropbox for HTTP Developers

team

team_log

Note: The Audit log endpoint is now available in preview for the Dropbox Business API v2. For production apps, we recommend you use the API v1 Audit log endpoint until the preview status is removed.

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.

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

Therefore Dropbox-API-Select-Admin header is particularly useful for accessing content that might not exist in any team member's Dropbox. An example of this is a shared folder that has been deleted from the Dropbox accounts of all team members that have access to it. Another example is a team folder that has no groups associated with it.

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.

For example, let's say your app is trying to retrieve metadata associated with cupcake.png in the shared folder Images with shared_folder_id 123456. Let's imagine Dan, the designer, is a collaborator on Images and has added this shared folder to their Dropbox, mounting it inside top-level folder Design (/Design/Images). The traditional method for an app with team member file access to retrieve metadata for cupcake.png would be to call files/get_metadata while impersonating Dan by his member_id and passing in the logical path /Design/Images/cupcake.png. However, the traditional method would fail if Dan were to remove Images from his Dropbox. Calling files/get_metadata while impersonating a team admin with the Dropbox-API-Select-Admin header, and passing in the namespace-relative path, ns:123456/cupcake.png would circumvent this issue, even if that team admin is not a member of Images.

While a namespace-relative path can be used with the Dropbox-API-Select-User header, the shared or team folder it specifies must be mounted in the Dropbox of the team member "selected" by the header.

Note that not all User API endpoints support the Dropbox-API-Select-Admin header. Here is a list of those that do:

  • files/get_metadata
  • files/list_folder
  • files/list_revisions
  • files/restore
  • files/upload
  • files/upload_session
  • files/copy
  • files/create_folder
  • files/delete
  • files/download
  • files/get_preview
  • files/get_temporary_link
  • files/get_thumbnail
  • files/move

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",
        ...
      ]
    },
    ...
  ]
}

team

/devices/list_member_devices

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

Description

List all device sessions of a team.

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/list_team_devices

DEPRECATED BY /devices/list_members_devices
Description

List all device sessions of a team.

URL Structure
https://api.dropboxapi.com/2/team/devices/list_team_devices
Authentication
Team Authentication
Endpoint format
RPC
Parameters
ListTeamDevicesArg
cursor String? At the first call to the devices/list_team_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
ListTeamDevicesResult
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_team_devices to retrieve the rest.
cursor String? Pass the cursor into devices/list_team_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"
    }
}
ListTeamDevicesError (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_team_devices again with an empty cursor to obtain a new cursor.

/devices/revoke_device_session

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
Parameters
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

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
Parameters
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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
RevokeDeviceSessionBatchError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.

/features/get_values

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 Dropbox for Business account 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 have a company shared dropbox.
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 for 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 team shared dropbox.
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

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

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",
                "joined_on": "2015-05-12T15:50:38Z"
            },
            "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.
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.
limited Void 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.
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.
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.
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

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

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.
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.
limited Void 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.
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.
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.
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

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

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

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

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\": {\".tag\": \"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": {
                ".tag": "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",
                    "joined_on": "2015-05-12T15:50:38Z"
                },
                "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.
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.
limited Void 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.
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.
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.
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

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 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.
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.
limited Void 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.
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.
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.
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

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.
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.
limited Void 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.
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.
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.
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

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",
                    "joined_on": "2015-05-12T15:50:38Z"
                },
                "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.
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.
limited Void 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.
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.
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.
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

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.
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.
limited Void 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.
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.
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.
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

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",
                "joined_on": "2015-05-12T15:50:38Z"
            },
            "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.
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.
limited Void 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.
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.
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.
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

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

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/list_team_linked_apps

DEPRECATED BY /linked_apps/list_members_linked_apps
Description

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

URL Structure
https://api.dropboxapi.com/2/team/linked_apps/list_team_linked_apps
Authentication
Team Authentication
Endpoint format
RPC
Parameters
ListTeamAppsArg
Arguments for linked_apps/list_team_linked_apps.
cursor String? At the first call to the linked_apps/list_team_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
ListTeamAppsResult
Information returned by linked_apps/list_team_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_team_linked_apps to retrieve the rest.
cursor String? Pass the cursor into linked_apps/list_team_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"
    }
}
ListTeamAppsError (open union)
Error returned by linked_apps/list_team_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_team_linked_apps again with an empty cursor to obtain a new cursor.

/linked_apps/revoke_linked_app

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

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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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.

/members/add

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\": {\".tag\": \"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": {
                ".tag": "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(min_length=1, max_length=100, pattern="[^/:?*<>"|]*")? Member's first name. This field is optional.
member_surname String(min_length=1, 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.
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",
                "joined_on": "2015-05-12T15:50:38Z"
            },
            "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.
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.
limited Void 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.
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.
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.
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

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",
                "joined_on": "2015-05-12T15:50:38Z"
            },
            "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.
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.
limited Void 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.
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.
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.
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/get_info

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.
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.
limited Void 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.
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.
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.
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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersGetInfoError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.

/members/list

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 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",
                "joined_on": "2015-05-12T15:50:38Z"
            },
            "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.
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.
limited Void 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.
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.
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.
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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
MembersListError (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.

/members/list/continue

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",
                "joined_on": "2015-05-12T15:50:38Z"
            },
            "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.
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.
limited Void 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.
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.
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.
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/recover

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

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.
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}"
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
}
MembersRemoveArg
user UserSelectorArg Identity of user to remove/suspend.
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.
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: remove_last_admin
{
    "error_summary": "remove_last_admin/...",
    "error": {
        ".tag": "remove_last_admin"
    }
}
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_found
{
    "error_summary": "transfer_admin_user_not_found/...",
    "error": {
        ".tag": "transfer_admin_user_not_found"
    }
}
Example: transfer_admin_user_not_in_team
{
    "error_summary": "transfer_admin_user_not_in_team/...",
    "error": {
        ".tag": "transfer_admin_user_not_in_team"
    }
}
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: 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"
    }
}
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.
remove_last_admin Void The user is the last admin of the team, so it cannot be removed from it.
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_found Void No matching user found for the argument transfer_admin_id.
transfer_admin_user_not_in_team Void The provided transfer_admin_id does not exist on this team.
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.
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.

/members/remove/job_status/get

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/send_welcome_email

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

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

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(min_length=1, max_length=100, pattern="[^/:?*<>"|]*")? New given name for member. This field is optional.
new_surname String(min_length=1, 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.
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",
        "joined_on": "2015-05-12T15:50:38Z"
    },
    "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.
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.
limited Void 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.
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.
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.
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: 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.

/members/suspend

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
Exactly one of team_member_id, email, or external_id must be provided to identify the user account.
user UserSelectorArg Identity of user to remove/suspend.
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

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

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\": 100}"
Parameters
{
    "limit": 100
}
TeamNamespacesListArg
limit UInt32 The approximate maximum number of results to return per request. This limit may be exceeded. 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 folder, the ID of the 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

No errors.

/namespaces/list/continue

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 folder, the ID of the 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_cursor
{
    "error_summary": "invalid_cursor/...",
    "error": {
        ".tag": "invalid_cursor"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
TeamNamespacesListContinueError (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.

/properties/template/add

PREVIEW - may change or disappear without notice
Description

Add a property template. See route files/properties/add to add properties to a file.

URL Structure
https://api.dropboxapi.com/2/team/properties/template/add
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/properties/template/add \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"name\": \"Security\",\"description\": \"These properties describe how confidential this file 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\"}}]}"
Parameters
{
    "name": "Security",
    "description": "These properties describe how confidential this file 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"
            }
        }
    ]
}
AddPropertyTemplateArg
Arguments for adding property templates.
name String A display name for the property template. Property template names can be up to 256 bytes.
description String Description for new property template. Property template descriptions can be up to 1024 bytes.
fields List of (PropertyFieldTemplate) This is a list of custom properties associated with a property template. There can be up to 64 properties in a single property template.
PropertyFieldTemplate
Describe a single property field type which that can be part of a property template. This datatype comes from an imported namespace originally defined in the properties namespace.
name String This is the name or key of a custom property in a property template. File property names can be up to 256 bytes.
description String This is the description for a custom property in a property template. File property description can be up to 1024 bytes.
type PropertyType This is the data type of the value of this property. This type will be enforced upon property creation and modifications.
PropertyType (open union)
Data type of the given property added. This endpoint is in beta and only properties of type strings is supported. This datatype comes from an imported namespace originally defined in the properties namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
string Void The associated property will be of type string. Unicode is supported.
Returns
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
AddPropertyTemplateResult
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for property template added by properties/template/add.
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"
    }
}
ModifyPropertyTemplateError (union)
This datatype comes from an imported namespace originally defined in the properties namespace. The value will be one of the following datatypes:
template_not_found String(min_length=1, pattern="(/|ptid:).*") Property template does not exist for given identifier.
restricted_content Void You do not have the permissions to modify this property template.
conflicting_property_names Void A property field 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 field names is too large.

/properties/template/get

PREVIEW - may change or disappear without notice
Description

Get the schema for a specified template.

URL Structure
https://api.dropboxapi.com/2/team/properties/template/get
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/properties/template/get \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"template_id\": \"ptid:1a5n2i6d3OYEAAAAAAAAAYa\"}"
Parameters
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
GetPropertyTemplateArg
This datatype comes from an imported namespace originally defined in the properties namespace.
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for property template added by route properties/template/add.
Returns
{
    "name": "Security",
    "description": "These properties describe how confidential this file 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"
            }
        }
    ]
}
GetPropertyTemplateResult
The Property template for the specified template. This datatype comes from an imported namespace originally defined in the properties namespace.
name String A display name for the property template. Property template names can be up to 256 bytes.
description String Description for new property template. Property template descriptions can be up to 1024 bytes.
fields List of (PropertyFieldTemplate) This is a list of custom properties associated with a property template. There can be up to 64 properties in a single property template.
PropertyFieldTemplate
Describe a single property field type which that can be part of a property template. This datatype comes from an imported namespace originally defined in the properties namespace.
name String This is the name or key of a custom property in a property template. File property names can be up to 256 bytes.
description String This is the description for a custom property in a property template. File property description can be up to 1024 bytes.
type PropertyType This is the data type of the value of this property. This type will be enforced upon property creation and modifications.
PropertyType (open union)
Data type of the given property added. This endpoint is in beta and only properties of type strings is supported. This datatype comes from an imported namespace originally defined in the properties namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
string Void The associated property 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"
    }
}
PropertyTemplateError (open union)
This datatype comes from an imported namespace originally defined in the properties namespace. 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:).*") Property template does not exist for given identifier.
restricted_content Void You do not have the permissions to modify this property template.

/properties/template/list

PREVIEW - may change or disappear without notice
Description

Get the property template identifiers for a team. To get the schema of each template use properties/template/get.

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

No parameters.

Returns
{
    "template_ids": [
        "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
    ]
}
ListPropertyTemplateIds
This datatype comes from an imported namespace originally defined in the properties namespace.
template_ids List of (String(min_length=1, pattern="(/|ptid:).*")) List of identifiers for templates added by route properties/template/add.
Errors
Example: restricted_content
{
    "error_summary": "restricted_content/...",
    "error": {
        ".tag": "restricted_content"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
PropertyTemplateError (open union)
This datatype comes from an imported namespace originally defined in the properties namespace. 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:).*") Property template does not exist for given identifier.
restricted_content Void You do not have the permissions to modify this property template.

/properties/template/update

PREVIEW - may change or disappear without notice
Description

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

URL Structure
https://api.dropboxapi.com/2/team/properties/template/update
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team/properties/template/update \
    --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 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\": {\".tag\": \"string\"}}]}"
Parameters
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa",
    "name": "New Security Template Name",
    "description": "These properties will describe how confidential this file 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": {
                ".tag": "string"
            }
        }
    ]
}
UpdatePropertyTemplateArg
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for property template added by properties/template/add.
name String? A display name for the property template. Property template names can be up to 256 bytes. This field is optional.
description String? Description for new property template. Property template descriptions can be up to 1024 bytes. This field is optional.
add_fields List of (PropertyFieldTemplate)? This is a list of custom properties to add to the property template. There can be up to 64 properties in a single property template. This field is optional.
PropertyFieldTemplate
Describe a single property field type which that can be part of a property template. This datatype comes from an imported namespace originally defined in the properties namespace.
name String This is the name or key of a custom property in a property template. File property names can be up to 256 bytes.
description String This is the description for a custom property in a property template. File property description can be up to 1024 bytes.
type PropertyType This is the data type of the value of this property. This type will be enforced upon property creation and modifications.
PropertyType (open union)
Data type of the given property added. This endpoint is in beta and only properties of type strings is supported. This datatype comes from an imported namespace originally defined in the properties namespace. The value will be one of the following datatypes. New values may be introduced as our API evolves.
string Void The associated property will be of type string. Unicode is supported.
Returns
{
    "template_id": "ptid:1a5n2i6d3OYEAAAAAAAAAYa"
}
UpdatePropertyTemplateResult
template_id String(min_length=1, pattern="(/|ptid:).*") An identifier for property template added by properties/template/add.
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"
    }
}
ModifyPropertyTemplateError (union)
This datatype comes from an imported namespace originally defined in the properties namespace. The value will be one of the following datatypes:
template_not_found String(min_length=1, pattern="(/|ptid:).*") Property template does not exist for given identifier.
restricted_content Void You do not have the permissions to modify this property template.
conflicting_property_names Void A property field 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 field names is too large.

/reports/get_activity

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) 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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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

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) 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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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

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) 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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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

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) 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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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

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
}
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 the team shared dropbox.
Errors
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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 team shared dropbox.

/team_folder/archive

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
}
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 the team shared dropbox.
Errors
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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 team shared dropbox.

/team_folder/archive/check

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
}
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 the team shared dropbox.
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 team shared dropbox.
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

Description

Creates a new, active, team folder.
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\"}"
Parameters
{
    "name": "Marketing"
}
TeamFolderCreateArg
name String Name for the new team folder.
Returns
{
    "team_folder_id": "123456789",
    "name": "Marketing",
    "status": {
        ".tag": "active"
    },
    "is_team_shared_dropbox": false
}
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 the team shared dropbox.
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.

/team_folder/get_info

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 the team shared dropbox.
Errors

No errors.

/team_folder/list

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 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
        }
    ],
    "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 the team shared dropbox.
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

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
        }
    ],
    "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 the team shared dropbox.
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

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
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
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 team shared dropbox.

/team_folder/rename

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
}
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 the team shared dropbox.
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 team shared dropbox.
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.

/token/get_authenticated_admin

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",
        "joined_on": "2015-05-12T15:50:38Z"
    }
}
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.
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.
limited Void 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.
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.
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.
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

PREVIEW - may change or disappear without notice
Description

Retrieves team events.
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}"
Parameters
{
    "limit": 50
}
GetTeamEventsArg
limit UInt32 Number of results to return per call. 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.
Returns
{
    "events": [
        {
            "timestamp": "2017-01-25T15:51:30Z",
            "event_categories": [
                {
                    ".tag": "sharing"
                }
            ],
            "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"
                }
            },
            "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"
            },
            "event_type": {
                ".tag": "shared_content_download"
            },
            "details": {
                ".tag": "shared_content_download_details",
                "shared_content_link": "abc",
                "target_index": 3,
                "sharing_permission": "abc"
            },
            "origin": {
                "access_method": {
                    ".tag": "end_user",
                    "end_user": {
                        ".tag": "web",
                        "session_id": "dbwsid:123456789012345678901234567890123456789"
                    }
                },
                "geo_location": {
                    "ip_address": "10.1.1.100",
                    "city": "San Francisco",
                    "region": "California",
                    "country": "US"
                },
                "host": {
                    "host_id": 3,
                    "host_name": "host.acmecorp.com"
                }
            },
            "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"
                    }
                }
            ],
            "assets": [
                {
                    ".tag": "file",
                    "path": {
                        "namespace_relative": {
                            "ns_id": "1234",
                            "relative_path": "/Contract Work/Product Design"
                        },
                        "contextual": "/Contract Work/Product Design"
                    },
                    "display_name": "reports.xls",
                    "file_id": "id:jQKLsZFQImAAAAAAEZAAQt"
                }
            ]
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GetTeamEventsResult
events List of (TeamEvent) List of events.
TeamEvent
An audit log event.
timestamp Timestamp(format="%Y-%m-%dT%H:%M:%SZ") The Dropbox timestamp representing when the action was taken.
event_categories List of (EventCategory, min_items=1) One or more categories 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.
account_capture Void Events that have to do with account capture and invite enforcement on team-owned domains.
administration Void Events that relate to team and team member account administration or team administration. Note that these actions are not necessarily performed by team admins. They might also be performed by Dropbox Support or System or by team members on their own accounts.
apps Void Events that apply to management of linked apps.
authentication Void Events that apply to user authentication in some way.
comments Void Events that have to do with comments on files and Paper documents.
content_access Void Events that apply to changes how people can access content on Dropbox as well as actions that represent actually accessing content.
devices Void Events that apply to linked devices on mobile, desktop and Web platforms.
device_approvals Void Events that concern device approvals and device management.
domains Void Events that involve domain management feature: domain verification, invite enforcement and account capture.
emm Void Events that involve enterprise mobility management and the Dropbox EMM app.
errors Void Events that mark some type of unexpected outcome.
files Void Events that mark a user's interaction with files and folders on Dropbox.
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.
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.
sessions Void Events that mark the beginning or end of sessions as well as those that apply to an ongoing session.
shared_files Void Events that specifically apply to shared files.
shared_folders Void Events that specifically apply to shared folders.
shared_links Void Events that specifically apply to link sharing.
sharing Void Events that apply to all types of sharing and collaboration.
sharing_policies Void Events that concern policies that affect sharing - both at the team level and at the folder level.
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.
actor ActorLogInfo The entity who actually performed the action.
ActorLogInfo (open union)
The entity who performed the action. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user UserLogInfo The user who did the action.
UserLogInfo (datatype with subtypes)
User's logged information. This datatype will be one of the following subtypes:
team_member TeamMemberLogInfo
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
admin UserLogInfo The admin who did the action.
UserLogInfo (datatype with subtypes)
User's logged information. This datatype will be one of the following subtypes:
team_member TeamMemberLogInfo
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
app AppLogInfo The application who did the action.
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.
reseller ResellerLogInfo Action done by reseller.
ResellerLogInfo
Reseller information.
reseller_name String Reseller name.
reseller_id String Reseller ID.
dropbox Void Action done by Dropbox.
involve_non_team_member Boolean True if the action involved a non team member either as the actor or as one of the affected users.
context ContextLogInfo The user or team on whose behalf the actor performed the action.
ContextLogInfo (open union)
The primary entity on which the action was done. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_member TeamMemberLogInfo Action was done on behalf of a team member.
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo Action was done on behalf of a non team member.
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team Void Action was done on behalf of the team.
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.
member_change_membership_type Void Changed the membership type (limited vs full) for team member.
member_permanently_delete_account_contents Void Permanently deleted contents of a removed team member account.
member_space_limits_change_status Void Changed the status with respect to whether the team member is under or over storage quota specified by policy.
member_transfer_account_contents Void Transferred contents of a removed team member account to another member.
paper_enabled_users_group_addition Void Users added to Paper enabled users list.
paper_enabled_users_group_removal Void Users removed from Paper enabled users list.
paper_external_view_allow Void Paper external sharing policy changed: anyone. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_external_view_default_team Void Paper external sharing policy changed: default team. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_external_view_forbid Void Paper external sharing policy changed: team-only. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_external_invite_warn Void Admin settings: team members see a warning before sharing folders outside the team (DEPRECATED FEATURE). This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
team_merge Void Merged the team into another team.
app_link_team Void Linked an app for team.
app_link_user Void Linked an app for team member.
app_unlink_team Void Unlinked an app for team.
app_unlink_user Void Unlinked an app for team member.
device_change_ip_desktop Void IP address associated with active desktop session changed.
device_change_ip_mobile Void IP address associated with active mobile session changed.
device_change_ip_web Void IP address associated with active Web session changed.
device_delete_on_unlink_fail Void Failed to delete all files from an unlinked device.
device_delete_on_unlink_success Void Deleted all files from an unlinked device.
device_link_fail Void Failed to link a device.
device_link_success Void Linked a device.
device_management_disabled Void Disable Device Management. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
device_management_enabled Void Enable Device Management. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
device_unlink Void Disconnected a device.
emm_refresh_auth_token Void Refreshed the auth token used for setting up enterprise mobility management.
account_capture_change_availability Void Granted or revoked the option to enable account capture on domains belonging to the team.
account_capture_migrate_account Void Account captured user migrated their account to the team.
account_capture_relinquish_account Void Account captured user relinquished their account by changing the email address associated with it.
disabled_domain_invites Void Disabled domain invites. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
domain_invites_approve_request_to_join_team Void Approved a member's request to join the team.
domain_invites_decline_request_to_join_team Void Declined a user's request to join the team.
domain_invites_email_existing_users Void Sent domain invites to existing domain accounts.
domain_invites_request_to_join_team Void Asked to join the team.
domain_invites_set_invite_new_user_pref_to_no Void Turned off u201cAutomatically invite new usersu201d. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
domain_invites_set_invite_new_user_pref_to_yes Void Turned on u201cAutomatically invite new usersu201d. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
domain_verification_add_domain_fail Void Failed to verify a domain belonging to the team.
domain_verification_add_domain_success Void Verified a domain belonging to the team.
domain_verification_remove_domain Void Removed a domain from the list of verified domains belonging to the team.
enabled_domain_invites Void Enabled domain invites. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
create_folder Void Created folders. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
file_add Void Added files and/or folders.
file_copy Void Copied files and/or folders.
file_delete Void Deleted files and/or folders.
file_download Void Downloaded files and/or folders.
file_edit Void Edited files.
file_get_copy_reference Void Create a copy reference to a file or folder.
file_move Void Moved files and/or folders.
file_permanently_delete Void Permanently deleted files and/or folders.
file_preview Void Previewed files and/or folders.
file_rename Void Renamed files and/or folders.
file_restore Void Restored deleted files and/or folders.
file_revert Void Reverted files to a previous version.
file_rollback_changes Void Rolled back file change location changes.
file_save_copy_reference Void Save a file or folder using a copy reference.
file_request_add_deadline Void Added a deadline to a file request.
file_request_change_folder Void Changed the file request folder.
file_request_change_title Void Change the file request title.
file_request_close Void Closed a file request.
file_request_create Void Created a file request.
file_request_receive_file Void Received files for a file request.
file_request_remove_deadline Void Removed the file request deadline.
file_request_send Void Sent file request to users via email.
group_add_external_id Void Added an external ID for group.
group_add_member Void Added team members to a group.
group_change_external_id Void Changed the external ID for group.
group_change_management_type Void Changed group management type.
group_change_member_role Void Changed the manager permissions belonging to a group member.
group_create Void Created a group.
group_delete Void Deleted a group.
group_description_updated Void Updated a group.
group_join_policy_updated Void Updated a group join policy.
group_moved Void Moved a group. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
group_remove_external_id Void Removed the external ID for group.
group_remove_member Void Removed team members from a group.
group_rename Void Renamed a group.
emm_login_success Void Signed in using the Dropbox EMM app.
logout Void Signed out.
password_login_fail Void Failed to sign in using a password.
password_login_success Void Signed in using a password.
reseller_support_session_end Void Ended reseller support session.
reseller_support_session_start Void Started reseller support session.
sign_in_as_session_end Void Ended admin sign-in-as session.
sign_in_as_session_start Void Started admin sign-in-as session.
sso_login_fail Void Failed to sign in using SSO.
member_add_name Void Set team member name when joining team.
member_change_email Void Changed team member email address.
member_change_name Void Changed team member name.
member_change_role Void Change the admin permissions belonging to team member.
member_change_status Void Changed the membership status of a team member.
member_suggest Void Suggested a new team member to be added to the team.
paper_content_add_member Void Added users to the membership of a Paper doc or folder.
paper_content_add_to_folder Void Added Paper doc or folder to a folder.
paper_content_archive Void Archived Paper doc or folder.
paper_content_change_subscription Void Followed or unfollowed a Paper doc or folder.
paper_content_create Void Created a Paper doc or folder.
paper_content_permanently_delete Void Permanently deleted a Paper doc or folder.
paper_content_remove_from_folder Void Removed Paper doc or folder from a folder.
paper_content_remove_member Void Removed a user from the membership of a Paper doc or folder.
paper_content_rename Void Renamed Paper doc or folder.
paper_content_restore Void Restored an archived Paper doc or folder.
paper_doc_add_comment Void Added a Paper doc comment.
paper_doc_change_member_role Void Changed the access type of a Paper doc member.
paper_doc_change_sharing_policy Void Changed the sharing policy for Paper doc.
paper_doc_deleted Void Paper doc archived. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_doc_delete_comment Void Deleted a Paper doc comment.
paper_doc_download Void Downloaded a Paper doc in a particular output format.
paper_doc_edit Void Edited a Paper doc.
paper_doc_edit_comment Void Edited a Paper doc comment.
paper_doc_followed Void Followed a Paper doc. This event is replaced by paper_content_change_subscription and will not be logged going forward.
paper_doc_mention Void Mentioned a member in a Paper doc.
paper_doc_request_access Void Requested to be a member on a Paper doc.
paper_doc_resolve_comment Void Paper doc comment resolved.
paper_doc_revert Void Restored a Paper doc to previous revision.
paper_doc_slack_share Void Paper doc link shared via slack.
paper_doc_team_invite Void Paper doc shared with team member. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_doc_unresolve_comment Void Unresolved a Paper doc comment.
paper_doc_view Void Viewed Paper doc.
paper_folder_deleted Void Paper folder archived. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_folder_followed Void Followed a Paper folder. This event is replaced by paper_content_change_subscription and will not be logged going forward.
paper_folder_team_invite Void Paper folder shared with team member. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
password_change Void Changed password.
password_reset Void Reset password.
password_reset_all Void Reset all team member passwords.
emm_create_exceptions_report Void EMM excluded users report created.
emm_create_usage_report Void EMM mobile app usage report created.
smart_sync_create_admin_privilege_report Void Smart Sync non-admin devices report created.
team_activity_create_report Void Created a team activity report.
collection_share Void Shared an album.
file_add_comment Void Added a file comment.
file_like_comment Void Liked a file comment. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
file_unlike_comment Void Unliked a file comment. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_acl_invite_only Void Changed a Paper document to be invite-only. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_acl_link Void Changed a Paper document to be link accessible. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_acl_team_link Void Changed a Paper document to be link accessible for the team. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_shared Void Shared a Paper doc. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_share_receive Void Shared Paper document received. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
open_note_shared Void Opened a shared Paper doc. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_add_group Void Added the team to a shared folder.
sf_allow_non_members_to_view_shared_links Void Allowed non collaborators to view links to files in a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_invite_group Void Invited a group to a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_nest Void Changed parent of shared folder.
sf_team_decline Void Declined a team member's invitation to a shared folder.
sf_team_grant_access Void Granted access to a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_invite Void Invited team members to a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_invite_change_role Void Changed a team member's role in a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_join Void Joined a team member's shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_join_from_oob_link Void Joined a team member's shared folder from a link. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_uninvite Void Unshared a folder with a team member. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
shared_content_add_invitees Void Sent an email invitation to the membership of a shared file or folder.
shared_content_add_link_expiry Void Added an expiry to the link for the shared file or folder.
shared_content_add_link_password Void Added a password to the link for the shared file or folder.
shared_content_add_member Void Added users and/or groups to the membership of a shared file or folder.
shared_content_change_downloads_policy Void Changed whether members can download the shared file or folder.
shared_content_change_invitee_role Void Changed the access type of an invitee to a shared file or folder before the invitation was claimed.
shared_content_change_link_audience Void Changed the audience of the link for a shared file or folder.
shared_content_change_link_expiry Void Changed the expiry of the link for the shared file or folder.
shared_content_change_link_password Void Changed the password on the link for the shared file or folder.
shared_content_change_member_role Void Changed the access type of a shared file or folder member.
shared_content_change_viewer_info_policy Void Changed whether members can see who viewed the shared file or folder.
shared_content_claim_invitation Void Claimed membership to a team member's shared folder.
shared_content_copy Void Copied the shared file or folder to own Dropbox.
shared_content_download Void Downloaded the shared file or folder.
shared_content_relinquish_membership Void Left the membership of a shared file or folder.
shared_content_remove_invitee Void Removed an invitee from the membership of a shared file or folder before it was claimed.
shared_content_remove_link_expiry Void Removed the expiry of the link for the shared file or folder.
shared_content_remove_link_password Void Removed the password on the link for the shared file or folder.
shared_content_remove_member Void Removed a user or a group from the membership of a shared file or folder.
shared_content_request_access Void Requested to be on the membership of a shared file or folder.
shared_content_unshare Void Unshared a shared file or folder by clearing its membership and turning off its link.
shared_content_view Void Previewed the shared file or folder.
shared_folder_change_confidentiality Void Set or unset the confidential flag on a shared folder.
shared_folder_change_link_policy Void Changed who can access the shared folder via a link.
shared_folder_change_member_management_policy Void Changed who can manage the membership of a shared folder.
shared_folder_change_member_policy Void Changed who can become a member of the shared folder.
shared_folder_create Void Created a shared folder.
shared_folder_mount Void Added a shared folder to own Dropbox.
shared_folder_transfer_ownership Void Transferred the ownership of a shared folder to another member.
shared_folder_unmount Void Deleted a shared folder from Dropbox.
shared_note_opened Void Shared Paper document was opened. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
shmodel_app_create Void Created a link to a file using an app.
shmodel_create Void Created a new link.
shmodel_disable Void Removed a link.
shmodel_fb_share Void Shared a link with Facebook users.
shmodel_group_share Void Shared a link with a group. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
shmodel_remove_expiration Void Removed the expiration date from a link.
shmodel_set_expiration Void Added an expiration date to a link.
shmodel_team_copy Void Added a team member's file/folder to their Dropbox from a link.
shmodel_team_download Void Downloaded a team member's file/folder from a link.
shmodel_team_share Void Shared a link with team members.
shmodel_team_view Void Opened a team member's link.
shmodel_visibility_password Void Password-protected a link.
shmodel_visibility_public Void Made a file/folder visible to anyone with the link.
shmodel_visibility_team_only Void Made a file/folder visible only to team members with the link.
remove_logout_url Void Removed single sign-on logout URL. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
remove_sso_url Void Changed the sign-out URL for SSO. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sso_change_cert Void Changed the X.509 certificate for SSO.
sso_change_login_url Void Changed the sign-in URL for SSO.
sso_change_logout_url Void Changed the sign-out URL for SSO.
sso_change_saml_identity_mode Void Changed the SAML identity mode for SSO.
team_folder_change_status Void Changed the archival status of a team folder.
team_folder_create Void Created a new team folder in active status.
team_folder_downgrade Void Downgraded a team folder to a regular shared folder.
team_folder_permanently_delete Void Permanently deleted an archived team folder.
team_folder_rename Void Renamed an active or archived team folder.
account_capture_change_policy Void Changed the account capture policy on a domain belonging to the team.
allow_download_disabled Void Disabled allow downloads. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
allow_download_enabled Void Enabled allow downloads. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
data_placement_restriction_change_policy Void Set a restriction policy regarding the location of data centers where team data resides.
data_placement_restriction_satisfy_policy Void Satisfied a previously set restriction policy regarding the location of data centers where team data resides (i.e. all data have been migrated according to the restriction placed).
device_approvals_change_desktop_policy Void Set or removed a limit on the number of computers each team member can link to their work Dropbox account.
device_approvals_change_mobile_policy Void Set or removed a limit on the number of mobiles devices each team member can link to their work Dropbox account.
device_approvals_change_overage_action Void Changed the action taken when a team member is already over the limits (e.g when they join the team, an admin lowers limits, etc.).
device_approvals_change_unlink_action Void Changed the action taken with respect to approval limits when a team member unlinks an approved device.
emm_add_exception Void Added an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
emm_change_policy Void Enabled or disabled enterprise mobility management for team members.
emm_remove_exception Void Removed an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
extended_version_history_change_policy Void Accepted or opted out of extended version history.
file_comments_change_policy Void Enabled or disabled commenting on team files.
file_requests_change_policy Void Enabled or disabled file requests.
file_requests_emails_enabled Void Enabled file request emails for everyone. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
file_requests_emails_restricted_to_team_only Void Allowed file request emails for the team. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
google_sso_change_policy Void Enabled or disabled Google single sign-on for the team.
group_user_management_change_policy Void Changed who can create groups.
member_requests_change_policy Void Changed whether users can find the team when not invited.
member_space_limits_add_exception Void Added an exception for one or more team members to bypass space limits imposed by policy.
member_space_limits_change_policy Void Changed the storage limits applied to team members by policy.
member_space_limits_remove_exception Void Removed an exception for one or more team members to bypass space limits imposed by policy.
member_suggestions_change_policy Void Enabled or disabled the option for team members to suggest new members to add to the team.
microsoft_office_addin_change_policy Void Enabled or disabled the Microsoft Office add-in, which lets team members save files to Dropbox directly from Microsoft Office.
network_control_change_policy Void Enabled or disabled network control.
paper_change_deployment_policy Void Changed whether Dropbox Paper, when enabled, is deployed to all teams or to specific members of the team.
paper_change_member_policy Void Changed whether team members can share Paper documents externally (i.e. outside the team), and if so, whether they should be accessible only by team members or anyone by default.
paper_change_policy Void Enabled or disabled Dropbox Paper for the team.
permanent_delete_change_policy Void Enabled or disabled the ability of team members to permanently delete content.
sharing_change_folder_join_policy Void Changed whether team members can join shared folders owned externally (i.e. outside the team).
sharing_change_link_policy Void Changed whether team members can share links externally (i.e. outside the team), and if so, whether links should be accessible only by team members or anyone by default.
sharing_change_member_policy Void Changed whether team members can share files and folders externally (i.e. outside the team).
smart_sync_change_policy Void Changed the default Smart Sync policy for team members.
smart_sync_not_opt_out Void Opted team into Smart Sync.
smart_sync_opt_out Void Opted team out of Smart Sync.
sso_change_policy Void Change the single sign-on policy for the team.
tfa_change_policy Void Change two-step verification policy for the team.
two_account_change_policy Void Enabled or disabled the option for team members to link a personal Dropbox account in addition to their work account to the same computer.
web_sessions_change_fixed_length_policy Void Changed how long team members can stay signed in to Dropbox on the web.
web_sessions_change_idle_length_policy Void Changed how long team members can be idle while signed in to Dropbox on the web.
team_profile_add_logo Void Added a team logo to be displayed on shared link headers.
team_profile_change_logo Void Changed the team logo to be displayed on shared link headers.
team_profile_change_name Void Changed the team name.
team_profile_remove_logo Void Removed the team logo to be displayed on shared link headers.
tfa_add_backup_phone Void Added a backup phone for two-step verification.
tfa_add_security_key Void Added a security key for two-step verification.
tfa_change_backup_phone Void Changed the backup phone for two-step verification.
tfa_change_status Void Enabled, disabled or changed the configuration for two-step verification.
tfa_remove_backup_phone Void Removed the backup phone for two-step verification.
tfa_remove_security_key Void Removed a security key for two-step verification.
tfa_reset Void Reset two-step verification for team member.
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.
member_change_membership_type_details MemberChangeMembershipTypeDetails Changed the membership type (limited vs full) for team member.
MemberChangeMembershipTypeDetails
Changed the membership type (limited vs full) for team 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.
full Void
free 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.
full Void
free Void
member_permanently_delete_account_contents_details MemberPermanentlyDeleteAccountContentsDetails Permanently deleted contents of a removed team member account.
MemberPermanentlyDeleteAccountContentsDetails
Permanently deleted contents of a removed team member account.
member_space_limits_change_status_details MemberSpaceLimitsChangeStatusDetails Changed the status with respect to whether the team member is under or over storage quota specified by policy.
MemberSpaceLimitsChangeStatusDetails
Changed the status with respect to whether the team member is under or over storage quota specified by policy.
previous_value SpaceLimitsStatus Previous storage quota status.
SpaceLimitsStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
within_quota Void
near_quota Void
over_quota Void
new_value SpaceLimitsStatus New storage quota status.
SpaceLimitsStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
within_quota Void
near_quota Void
over_quota Void
member_transfer_account_contents_details MemberTransferAccountContentsDetails Transferred contents of a removed team member account to another member.
MemberTransferAccountContentsDetails
Transferred contents of a removed team member account to another member.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
paper_enabled_users_group_addition_details PaperEnabledUsersGroupAdditionDetails Users added to Paper enabled users list.
PaperEnabledUsersGroupAdditionDetails
Users added to Paper enabled users list.
paper_enabled_users_group_removal_details PaperEnabledUsersGroupRemovalDetails Users removed from Paper enabled users list.
PaperEnabledUsersGroupRemovalDetails
Users removed from Paper enabled users list.
paper_external_view_allow_details PaperExternalViewAllowDetails Paper external sharing policy changed: anyone.
PaperExternalViewAllowDetails
Paper external sharing policy changed: anyone.
paper_external_view_default_team_details PaperExternalViewDefaultTeamDetails Paper external sharing policy changed: default team.
PaperExternalViewDefaultTeamDetails
Paper external sharing policy changed: default team.
paper_external_view_forbid_details PaperExternalViewForbidDetails Paper external sharing policy changed: team-only.
PaperExternalViewForbidDetails
Paper external sharing policy changed: team-only.
sf_external_invite_warn_details SfExternalInviteWarnDetails Admin settings: team members see a warning before sharing folders outside the team (DEPRECATED FEATURE).
SfExternalInviteWarnDetails
Admin settings: team members see a warning before sharing folders outside the team (DEPRECATED FEATURE).
team_merge_details TeamMergeDetails Merged the team into another team.
TeamMergeDetails
Merged the team into another team.
merged_from_team_name String? Merged from team name. Might be missing due to historical data gap. This field is optional.
merged_to_team_name String? Merged to team name. Might be missing due to historical data gap. This field is optional.
app_link_team_details AppLinkTeamDetails Linked an app for team.
AppLinkTeamDetails
Linked an 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 Linked an app for team member.
AppLinkUserDetails
Linked an app for team 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 Unlinked an app for team.
AppUnlinkTeamDetails
Unlinked an 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 Unlinked an app for team member.
AppUnlinkUserDetails
Unlinked an app for team 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.
device_change_ip_desktop_details DeviceChangeIpDesktopDetails IP address associated with active desktop session changed.
DeviceChangeIpDesktopDetails
IP address associated with active desktop session changed.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_change_ip_mobile_details DeviceChangeIpMobileDetails IP address associated with active mobile session changed.
DeviceChangeIpMobileDetails
IP address associated with active mobile session changed.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_change_ip_web_details DeviceChangeIpWebDetails IP address associated with active Web session changed.
DeviceChangeIpWebDetails
IP address associated with active Web session changed.
user_agent String Web browser name.
device_info DeviceLogInfo? Device information. Might be missing due to historical data gap. This field is optional.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_delete_on_unlink_fail_details DeviceDeleteOnUnlinkFailDetails Failed to delete all files from an unlinked device.
DeviceDeleteOnUnlinkFailDetails
Failed to delete all files from an unlinked device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
num_failures Int64 The number of times that remote file deletion failed.
device_delete_on_unlink_success_details DeviceDeleteOnUnlinkSuccessDetails Deleted all files from an unlinked device.
DeviceDeleteOnUnlinkSuccessDetails
Deleted all files from an unlinked device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_link_fail_details DeviceLinkFailDetails Failed to link a device.
DeviceLinkFailDetails
Failed to link a 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.
mobile Void
desktop Void
device_info DeviceLogInfo? Device information. Might be missing due to historical data gap. This field is optional.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_link_success_details DeviceLinkSuccessDetails Linked a device.
DeviceLinkSuccessDetails
Linked a device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
app_version String? Linking app version. Might be missing due to historical data gap. This field is optional.
device_management_disabled_details DeviceManagementDisabledDetails Disable Device Management.
DeviceManagementDisabledDetails
Disable Device Management.
device_management_enabled_details DeviceManagementEnabledDetails Enable Device Management.
DeviceManagementEnabledDetails
Enable Device Management.
device_unlink_details DeviceUnlinkDetails Disconnected a device.
DeviceUnlinkDetails
Disconnected a device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
delete_data Boolean True if the user requested to delete data after device unlink, false otherwise.
emm_refresh_auth_token_details EmmRefreshAuthTokenDetails Refreshed the auth token used for setting up enterprise mobility management.
EmmRefreshAuthTokenDetails
Refreshed the auth token used for setting up enterprise mobility management.
account_capture_change_availability_details AccountCaptureChangeAvailabilityDetails Granted or revoked the option to enable account capture on domains belonging to the team.
AccountCaptureChangeAvailabilityDetails
Granted or revoked the option to enable account capture on domains belonging to the team.
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 Account captured user migrated their account to the team.
AccountCaptureMigrateAccountDetails
Account captured user migrated their account to the team.
domain_name String Domain name.
account_capture_relinquish_account_details AccountCaptureRelinquishAccountDetails Account captured user relinquished their account by changing the email address associated with it.
AccountCaptureRelinquishAccountDetails
Account captured user relinquished their account by changing the email address associated with it.
domain_name String Domain name.
disabled_domain_invites_details DisabledDomainInvitesDetails Disabled domain invites.
DisabledDomainInvitesDetails
Disabled domain invites.
domain_invites_approve_request_to_join_team_details DomainInvitesApproveRequestToJoinTeamDetails Approved a member's request to join the team.
DomainInvitesApproveRequestToJoinTeamDetails
Approved a member's request to join the team.
domain_invites_decline_request_to_join_team_details DomainInvitesDeclineRequestToJoinTeamDetails Declined a user's request to join the team.
DomainInvitesDeclineRequestToJoinTeamDetails
Declined a user's request to join the team.
domain_invites_email_existing_users_details DomainInvitesEmailExistingUsersDetails Sent domain invites to existing domain accounts.
DomainInvitesEmailExistingUsersDetails
Sent domain invites to existing domain accounts.
domain_name List of (String) Domain names.
num_recipients UInt64 Number of recipients.
domain_invites_request_to_join_team_details DomainInvitesRequestToJoinTeamDetails Asked to join the team.
DomainInvitesRequestToJoinTeamDetails
Asked to join the team.
domain_invites_set_invite_new_user_pref_to_no_details DomainInvitesSetInviteNewUserPrefToNoDetails Turned off u201cAutomatically invite new usersu201d.
DomainInvitesSetInviteNewUserPrefToNoDetails
Turned off u201cAutomatically invite new usersu201d.
domain_invites_set_invite_new_user_pref_to_yes_details DomainInvitesSetInviteNewUserPrefToYesDetails Turned on u201cAutomatically invite new usersu201d.
DomainInvitesSetInviteNewUserPrefToYesDetails
Turned on u201cAutomatically invite new usersu201d.
domain_verification_add_domain_fail_details DomainVerificationAddDomainFailDetails Failed to verify a domain belonging to the team.
DomainVerificationAddDomainFailDetails
Failed to verify a domain belonging to the team.
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 Verified a domain belonging to the team.
DomainVerificationAddDomainSuccessDetails
Verified a domain belonging to the team.
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 Removed a domain from the list of verified domains belonging to the team.
DomainVerificationRemoveDomainDetails
Removed a domain from the list of verified domains belonging to the team.
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.
enabled_domain_invites_details EnabledDomainInvitesDetails Enabled domain invites.
EnabledDomainInvitesDetails
Enabled domain invites.
create_folder_details CreateFolderDetails Created folders.
CreateFolderDetails
Created folders.
file_add_details FileAddDetails Added files and/or folders.
FileAddDetails
Added files and/or folders.
file_copy_details FileCopyDetails Copied files and/or folders.
FileCopyDetails
Copied files and/or folders.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_delete_details FileDeleteDetails Deleted files and/or folders.
FileDeleteDetails
Deleted files and/or folders.
file_download_details FileDownloadDetails Downloaded files and/or folders.
FileDownloadDetails
Downloaded files and/or folders.
file_edit_details FileEditDetails Edited files.
FileEditDetails
Edited files.
file_get_copy_reference_details FileGetCopyReferenceDetails Create a copy reference to a file or folder.
FileGetCopyReferenceDetails
Create a copy reference to a file or folder.
file_move_details FileMoveDetails Moved files and/or folders.
FileMoveDetails
Moved files and/or folders.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_permanently_delete_details FilePermanentlyDeleteDetails Permanently deleted files and/or folders.
FilePermanentlyDeleteDetails
Permanently deleted files and/or folders.
file_preview_details FilePreviewDetails Previewed files and/or folders.
FilePreviewDetails
Previewed files and/or folders.
file_rename_details FileRenameDetails Renamed files and/or folders.
FileRenameDetails
Renamed files and/or folders.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_restore_details FileRestoreDetails Restored deleted files and/or folders.
FileRestoreDetails
Restored deleted files and/or folders.
file_revert_details FileRevertDetails Reverted files to a previous version.
FileRevertDetails
Reverted files to a previous version.
file_rollback_changes_details FileRollbackChangesDetails Rolled back file change location changes.
FileRollbackChangesDetails
Rolled back file change location changes.
file_save_copy_reference_details FileSaveCopyReferenceDetails Save a file or folder using a copy reference.
FileSaveCopyReferenceDetails
Save a file or folder using a copy reference.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_request_add_deadline_details FileRequestAddDeadlineDetails Added a deadline to a file request.
FileRequestAddDeadlineDetails
Added a deadline to a file request.
request_title String File request title.
file_request_change_folder_details FileRequestChangeFolderDetails Changed the file request folder.
FileRequestChangeFolderDetails
Changed the file request folder.
request_title String File request title.
file_request_change_title_details FileRequestChangeTitleDetails Change the file request title.
FileRequestChangeTitleDetails
Change the file request title.
request_title String File request title.
file_request_close_details FileRequestCloseDetails Closed a file request.
FileRequestCloseDetails
Closed a file request.
request_title String File request title.
file_request_create_details FileRequestCreateDetails Created a file request.
FileRequestCreateDetails
Created a file request.
request_title String File request title.
file_request_receive_file_details FileRequestReceiveFileDetails Received files for a file request.
FileRequestReceiveFileDetails
Received files for a file request.
request_title String File request title.
submitted_file_names List of (String) Submitted file names.
file_request_remove_deadline_details FileRequestRemoveDeadlineDetails Removed the file request deadline.
FileRequestRemoveDeadlineDetails
Removed the file request deadline.
request_title String File request title.
file_request_send_details FileRequestSendDetails Sent file request to users via email.
FileRequestSendDetails
Sent file request to users via email.
request_title String File request title.
group_add_external_id_details GroupAddExternalIdDetails Added an external ID for group.
GroupAddExternalIdDetails
Added an external ID for group.
new_value String Current external id.
group_add_member_details GroupAddMemberDetails Added team members to a group.
GroupAddMemberDetails
Added team members to a group.
is_group_owner Boolean Is group owner.
group_change_external_id_details GroupChangeExternalIdDetails Changed the external ID for group.
GroupChangeExternalIdDetails
Changed the external ID for group.
new_value String Current external id.
previous_value String Old external id.
group_change_management_type_details GroupChangeManagementTypeDetails Changed group management type.
GroupChangeManagementTypeDetails
Changed group management type.
new_value GroupManagementType New group management type.
GroupManagementType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
admin_management_group Void
member_management_group Void
previous_value GroupManagementType? Previous group management type. Might be missing due to historical data gap. This field is optional.
GroupManagementType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
admin_management_group Void
member_management_group Void
group_change_member_role_details GroupChangeMemberRoleDetails Changed the manager permissions belonging to a group member.
GroupChangeMemberRoleDetails
Changed the manager permissions belonging to a group member.
is_group_owner Boolean Is group owner.
group_create_details GroupCreateDetails Created a group.
GroupCreateDetails
Created a group.
join_policy GroupJoinPolicy Group join policy.
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
is_admin_managed Boolean? Is admin managed group. Might be missing due to historical data gap. This field is optional.
group_delete_details GroupDeleteDetails Deleted a group.
GroupDeleteDetails
Deleted a group.
is_admin_managed Boolean? Is admin managed group. Might be missing due to historical data gap. This field is optional.
group_description_updated_details GroupDescriptionUpdatedDetails Updated a group.
GroupDescriptionUpdatedDetails
Updated a group.
group_join_policy_updated_details GroupJoinPolicyUpdatedDetails Updated a group join policy.
GroupJoinPolicyUpdatedDetails
Updated a group join policy.
join_policy GroupJoinPolicy Group join policy.
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
is_admin_managed Boolean? Is admin managed group. Might be missing due to historical data gap. This field is optional.
group_moved_details GroupMovedDetails Moved a group.
GroupMovedDetails
Moved a group.
group_remove_external_id_details GroupRemoveExternalIdDetails Removed the external ID for group.
GroupRemoveExternalIdDetails
Removed the external ID for group.
previous_value String Old external id.
group_remove_member_details GroupRemoveMemberDetails Removed team members from a group.
GroupRemoveMemberDetails
Removed team members from a group.
group_rename_details GroupRenameDetails Renamed a group.
GroupRenameDetails
Renamed a group.
previous_value String Previous display name.
emm_login_success_details EmmLoginSuccessDetails Signed in using the Dropbox EMM app.
EmmLoginSuccessDetails
Signed in using the Dropbox EMM app.
logout_details LogoutDetails Signed out.
LogoutDetails
Signed out.
password_login_fail_details PasswordLoginFailDetails Failed to sign in using a password.
PasswordLoginFailDetails
Failed to sign in using a password.
failure_reason String? Login failure reason. Might be missing due to historical data gap. This field is optional.
password_login_success_details PasswordLoginSuccessDetails Signed in using a password.
PasswordLoginSuccessDetails
Signed in using a password.
reseller_support_session_end_details ResellerSupportSessionEndDetails Ended reseller support session.
ResellerSupportSessionEndDetails
Ended reseller support session.
reseller_support_session_start_details ResellerSupportSessionStartDetails Started reseller support session.
ResellerSupportSessionStartDetails
Started reseller support session.
sign_in_as_session_end_details SignInAsSessionEndDetails Ended admin sign-in-as session.
SignInAsSessionEndDetails
Ended admin sign-in-as session.
sign_in_as_session_start_details SignInAsSessionStartDetails Started admin sign-in-as session.
SignInAsSessionStartDetails
Started admin sign-in-as session.
sso_login_fail_details SsoLoginFailDetails Failed to sign in using SSO.
SsoLoginFailDetails
Failed to sign in using SSO.
failure_reason String? Login failure reason. Might be missing due to historical data gap. This field is optional.
tech_reason String? Technical failure reason. This field is optional.
member_add_name_details MemberAddNameDetails Set team member name when joining team.
MemberAddNameDetails
Set team member name when joining team.
new_value UserNameLogInfo 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_email_details MemberChangeEmailDetails Changed team member email address.
MemberChangeEmailDetails
Changed team member email address.
new_value String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$") New email.
previous_value String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? Previous email. Might be missing due to historical data gap. This field is optional.
member_change_name_details MemberChangeNameDetails Changed team member name.
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.
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_role_details MemberChangeRoleDetails Change the admin permissions belonging to team member.
MemberChangeRoleDetails
Change the admin permissions belonging to team member.
new_value String? New admin role. Might be missing due to historical data gap. This field is optional.
previous_value String? Previous admin role. Might be missing due to historical data gap. This field is optional.
member_change_status_details MemberChangeStatusDetails Changed the membership status of a team member.
MemberChangeStatusDetails
Changed the membership status of a team member.
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
team_join_details JoinTeamDetails? Additional information relevant when a new member joins the team. This field is optional.
JoinTeamDetails
Additional information relevant when a new member joins the team.
linked_apps List of (AppLogInfo) Linked applications.
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.
linked_devices List of (DeviceLogInfo) Linked devices.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
linked_shared_folders List of (FolderLogInfo) Linked shared folders.
FolderLogInfo
Folder's logged information.
path PathLogInfo Path relative to event context.
PathLogInfo
Path's details.
namespace_relative NamespaceRelativePathLogInfo Path relative to the namespace containing the content.
NamespaceRelativePathLogInfo
Namespace relative path details.
ns_id String(pattern="[-_0-9a-zA-Z:]+")? Namespace ID. Might be missing due to historical data gap. This field is optional.
relative_path String(pattern="/(.|[\r\n])*")? A path relative to the specified namespace ID. Might be missing due to historical data gap. This field is optional.
contextual String(pattern="/(.|[\r\n])*")? Fully qualified path relative to event's context. Might be missing due to historical data gap. This field is optional.
display_name String? Display name. Might be missing due to historical data gap. This field is optional.
file_id String? Unique ID. Might be missing due to historical data gap. This field is optional.
member_suggest_details MemberSuggestDetails Suggested a new team member to be added to the team.
MemberSuggestDetails
Suggested a new team member to be added to the team.
paper_content_add_member_details PaperContentAddMemberDetails Added users to the membership of a Paper doc or folder.
PaperContentAddMemberDetails
Added users to the membership of a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_add_to_folder_details PaperContentAddToFolderDetails Added Paper doc or folder to a folder.
PaperContentAddToFolderDetails
Added Paper doc or folder to a folder.
event_uuid String Event unique identifier.
target_index Int64 Target asset index.
parent_index Int64 Parent asset index.
paper_content_archive_details PaperContentArchiveDetails Archived Paper doc or folder.
PaperContentArchiveDetails
Archived Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_change_subscription_details PaperContentChangeSubscriptionDetails Followed or unfollowed a Paper doc or folder.
PaperContentChangeSubscriptionDetails
Followed or unfollowed a Paper doc or folder.
event_uuid String Event unique identifier.
new_subscription_level PaperTaggedValue New subscription level.
PaperTaggedValue
Paper tagged value.
tag String Tag.
previous_subscription_level PaperTaggedValue? Previous subscription level. Might be missing due to historical data gap. This field is optional.
PaperTaggedValue
Paper tagged value.
tag String Tag.
paper_content_create_details PaperContentCreateDetails Created a Paper doc or folder.
PaperContentCreateDetails
Created a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_permanently_delete_details PaperContentPermanentlyDeleteDetails Permanently deleted a Paper doc or folder.
PaperContentPermanentlyDeleteDetails
Permanently deleted a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_remove_from_folder_details PaperContentRemoveFromFolderDetails Removed Paper doc or folder from a folder.
PaperContentRemoveFromFolderDetails
Removed Paper doc or folder from a folder.
event_uuid String Event unique identifier.
paper_content_remove_member_details PaperContentRemoveMemberDetails Removed a user from the membership of a Paper doc or folder.
PaperContentRemoveMemberDetails
Removed a user from the membership of a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_rename_details PaperContentRenameDetails Renamed Paper doc or folder.
PaperContentRenameDetails
Renamed Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_restore_details PaperContentRestoreDetails Restored an archived Paper doc or folder.
PaperContentRestoreDetails
Restored an archived Paper doc or folder.
event_uuid String Event unique identifier.
paper_doc_add_comment_details PaperDocAddCommentDetails Added a Paper doc comment.
PaperDocAddCommentDetails
Added a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_change_member_role_details PaperDocChangeMemberRoleDetails Changed the access type of a Paper doc member.
PaperDocChangeMemberRoleDetails
Changed the access type of a Paper doc member.
event_uuid String Event unique identifier.
access_type PaperAccessType Paper doc access type.
PaperAccessType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
viewer Void
commenter Void
editor Void
paper_doc_change_sharing_policy_details PaperDocChangeSharingPolicyDetails Changed the sharing policy for Paper doc.
PaperDocChangeSharingPolicyDetails
Changed the sharing policy for Paper doc.
event_uuid String Event unique identifier.
public_sharing_policy String? Sharing policy with external users. Might be missing due to historical data gap. This field is optional.
team_sharing_policy String? Sharing policy with team. Might be missing due to historical data gap. This field is optional.
paper_doc_deleted_details PaperDocDeletedDetails Paper doc archived.
PaperDocDeletedDetails
Paper doc archived.
event_uuid String Event unique identifier.
paper_doc_delete_comment_details PaperDocDeleteCommentDetails Deleted a Paper doc comment.
PaperDocDeleteCommentDetails
Deleted a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_download_details PaperDocDownloadDetails Downloaded a Paper doc in a particular output format.
PaperDocDownloadDetails
Downloaded a Paper doc in a particular output format.
event_uuid String Event unique identifier.
export_file_format PaperDownloadFormat Export file format.
PaperDownloadFormat (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
docx Void
html Void
markdown Void
paper_doc_edit_details PaperDocEditDetails Edited a Paper doc.
PaperDocEditDetails
Edited a Paper doc.
event_uuid String Event unique identifier.
paper_doc_edit_comment_details PaperDocEditCommentDetails Edited a Paper doc comment.
PaperDocEditCommentDetails
Edited a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_followed_details PaperDocFollowedDetails Followed a Paper doc.
PaperDocFollowedDetails
Followed a Paper doc.
event_uuid String Event unique identifier.
paper_doc_mention_details PaperDocMentionDetails Mentioned a member in a Paper doc.
PaperDocMentionDetails
Mentioned a member in a Paper doc.
event_uuid String Event unique identifier.
paper_doc_request_access_details PaperDocRequestAccessDetails Requested to be a member on a Paper doc.
PaperDocRequestAccessDetails
Requested to be a member on a Paper doc.
event_uuid String Event unique identifier.
paper_doc_resolve_comment_details PaperDocResolveCommentDetails Paper doc comment resolved.
PaperDocResolveCommentDetails
Paper doc comment resolved.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_revert_details PaperDocRevertDetails Restored a Paper doc to previous revision.
PaperDocRevertDetails
Restored a Paper doc to previous revision.
event_uuid String Event unique identifier.
paper_doc_slack_share_details PaperDocSlackShareDetails Paper doc link shared via slack.
PaperDocSlackShareDetails
Paper doc link shared via slack.
event_uuid String Event unique identifier.
paper_doc_team_invite_details PaperDocTeamInviteDetails Paper doc shared with team member.
PaperDocTeamInviteDetails
Paper doc shared with team member.
event_uuid String Event unique identifier.
paper_doc_unresolve_comment_details PaperDocUnresolveCommentDetails Unresolved a Paper doc comment.
PaperDocUnresolveCommentDetails
Unresolved a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_view_details PaperDocViewDetails Viewed Paper doc.
PaperDocViewDetails
Viewed Paper doc.
event_uuid String Event unique identifier.
paper_folder_deleted_details PaperFolderDeletedDetails Paper folder archived.
PaperFolderDeletedDetails
Paper folder archived.
event_uuid String Event unique identifier.
paper_folder_followed_details PaperFolderFollowedDetails Followed a Paper folder.
PaperFolderFollowedDetails
Followed a Paper folder.
event_uuid String Event unique identifier.
paper_folder_team_invite_details PaperFolderTeamInviteDetails Paper folder shared with team member.
PaperFolderTeamInviteDetails
Paper folder shared with team member.
event_uuid String Event unique identifier.
password_change_details PasswordChangeDetails Changed password.
PasswordChangeDetails
Changed password.
password_reset_details PasswordResetDetails Reset password.
PasswordResetDetails
Reset password.
password_reset_all_details PasswordResetAllDetails Reset all team member passwords.
PasswordResetAllDetails
Reset all team member passwords.
emm_create_exceptions_report_details EmmCreateExceptionsReportDetails EMM excluded users report created.
EmmCreateExceptionsReportDetails
EMM excluded users report created.
emm_create_usage_report_details EmmCreateUsageReportDetails EMM mobile app usage report created.
EmmCreateUsageReportDetails
EMM mobile app usage report created.
smart_sync_create_admin_privilege_report_details SmartSyncCreateAdminPrivilegeReportDetails Smart Sync non-admin devices report created.
SmartSyncCreateAdminPrivilegeReportDetails
Smart Sync non-admin devices report created.
team_activity_create_report_details TeamActivityCreateReportDetails Created a team activity report.
TeamActivityCreateReportDetails
Created a team activity report.
start_date Timestamp(format="%Y-%m-%d") Report start date.
end_date Timestamp(format="%Y-%m-%d") Report end date.
collection_share_details CollectionShareDetails Shared an album.
CollectionShareDetails
Shared an album.
album_name String Album name.
file_add_comment_details FileAddCommentDetails Added a file comment.
FileAddCommentDetails
Added a file comment.
target_index Int64 Target asset index.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_like_comment_details FileLikeCommentDetails Liked a file comment.
FileLikeCommentDetails
Liked a file comment.
target_index Int64 Target asset index.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_unlike_comment_details FileUnlikeCommentDetails Unliked a file comment.
FileUnlikeCommentDetails
Unliked a file comment.
target_index Int64 Target asset index.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
note_acl_invite_only_details NoteAclInviteOnlyDetails Changed a Paper document to be invite-only.
NoteAclInviteOnlyDetails
Changed a Paper document to be invite-only.
note_acl_link_details NoteAclLinkDetails Changed a Paper document to be link accessible.
NoteAclLinkDetails
Changed a Paper document to be link accessible.
note_acl_team_link_details NoteAclTeamLinkDetails Changed a Paper document to be link accessible for the team.
NoteAclTeamLinkDetails
Changed a Paper document to be link accessible for the team.
note_shared_details NoteSharedDetails Shared a Paper doc.
NoteSharedDetails
Shared a Paper doc.
note_share_receive_details NoteShareReceiveDetails Shared Paper document received.
NoteShareReceiveDetails
Shared Paper document received.
open_note_shared_details OpenNoteSharedDetails Opened a shared Paper doc.
OpenNoteSharedDetails
Opened a shared Paper doc.
sf_add_group_details SfAddGroupDetails Added the team to a shared folder.
SfAddGroupDetails
Added the team to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
team_name String Team name.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
sf_allow_non_members_to_view_shared_links_details SfAllowNonMembersToViewSharedLinksDetails Allowed non collaborators to view links to files in a shared folder.
SfAllowNonMembersToViewSharedLinksDetails
Allowed non collaborators to view links to files in a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
sf_invite_group_details SfInviteGroupDetails Invited a group to a shared folder.
SfInviteGroupDetails
Invited a group to a shared folder.
target_index Int64 Target asset index.
sf_nest_details SfNestDetails Changed parent of shared folder.
SfNestDetails
Changed parent of shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
prev_parent_ns_id String(pattern="[-_0-9a-zA-Z:]+")? Previous parent namespace ID. Might be missing due to historical data gap. This field is optional.
new_parent_ns_id String(pattern="[-_0-9a-zA-Z:]+")? New parent namespace ID. Might be missing due to historical data gap. This field is optional.
sf_team_decline_details SfTeamDeclineDetails Declined a team member's invitation to a shared folder.
SfTeamDeclineDetails
Declined a team member's invitation to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sf_team_grant_access_details SfTeamGrantAccessDetails Granted access to a shared folder.
SfTeamGrantAccessDetails
Granted access to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sf_team_invite_details SfTeamInviteDetails Invited team members to a shared folder.
SfTeamInviteDetails
Invited team members to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
sf_team_invite_change_role_details SfTeamInviteChangeRoleDetails Changed a team member's role in a shared folder.
SfTeamInviteChangeRoleDetails
Changed a team member's role in a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
previous_sharing_permission String? Previous sharing permission. Might be missing due to historical data gap. This field is optional.
sf_team_join_details SfTeamJoinDetails Joined a team member's shared folder.
SfTeamJoinDetails
Joined a team member's shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sf_team_join_from_oob_link_details SfTeamJoinFromOobLinkDetails Joined a team member's shared folder from a link.
SfTeamJoinFromOobLinkDetails
Joined a team member's shared folder from a link.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
token_key String? Shared link token key. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
sf_team_uninvite_details SfTeamUninviteDetails Unshared a folder with a team member.
SfTeamUninviteDetails
Unshared a folder with a team member.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_content_add_invitees_details SharedContentAddInviteesDetails Sent an email invitation to the membership of a shared file or folder.
SharedContentAddInviteesDetails
Sent an email invitation to the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_add_link_expiry_details SharedContentAddLinkExpiryDetails Added an expiry to the link for the shared file or folder.
SharedContentAddLinkExpiryDetails
Added an expiry to the link for the shared file or folder.
target_index Int64 Target asset index.
expiration_start_date String Expiration starting date.
expiration_days Int64 The number of days from the starting expiration date after which the link will expire.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_add_link_password_details SharedContentAddLinkPasswordDetails Added a password to the link for the shared file or folder.
SharedContentAddLinkPasswordDetails
Added a password to the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_add_member_details SharedContentAddMemberDetails Added users and/or groups to the membership of a shared file or folder.
SharedContentAddMemberDetails
Added users and/or groups to the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_change_downloads_policy_details SharedContentChangeDownloadsPolicyDetails Changed whether members can download the shared file or folder.
SharedContentChangeDownloadsPolicyDetails
Changed whether members can download the shared file or folder.
target_index Int64 Target asset index.
new_value SharedContentDownloadsPolicy New downlaod policy.
SharedContentDownloadsPolicy (open union)
Shared content downloads policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedContentDownloadsPolicy? Previous downlaod policy. Might be missing due to historical data gap. This field is optional.
SharedContentDownloadsPolicy (open union)
Shared content downloads policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
shared_content_change_invitee_role_details SharedContentChangeInviteeRoleDetails Changed the access type of an invitee to a shared file or folder before the invitation was claimed.
SharedContentChangeInviteeRoleDetails
Changed the access type of an invitee to a shared file or folder before the invitation was claimed.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
previous_sharing_permission String? Previous sharing permission. Might be missing due to historical data gap. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_change_link_audience_details SharedContentChangeLinkAudienceDetails Changed the audience of the link for a shared file or folder.
SharedContentChangeLinkAudienceDetails
Changed the audience of the link for a shared file or folder.
target_index Int64 Target asset index.
new_value LinkAudience New link audience value.
LinkAudience (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
public Void
team Void
members Void
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value LinkAudience? Previous link audience value. Might be missing due to historical data gap. This field is optional.
LinkAudience (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
public Void
team Void
members Void
shared_content_change_link_expiry_details SharedContentChangeLinkExpiryDetails Changed the expiry of the link for the shared file or folder.
SharedContentChangeLinkExpiryDetails
Changed the expiry of the link for the shared file or folder.
target_index Int64 Target asset index.
expiration_start_date String Expiration starting date.
expiration_days Int64 The number of days from the starting expiration date after which the link will expire.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_change_link_password_details SharedContentChangeLinkPasswordDetails Changed the password on the link for the shared file or folder.
SharedContentChangeLinkPasswordDetails
Changed the password on the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_change_member_role_details SharedContentChangeMemberRoleDetails Changed the access type of a shared file or folder member.
SharedContentChangeMemberRoleDetails
Changed the access type of a shared file or folder member.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_sharing_permission String? Previous sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_change_viewer_info_policy_details SharedContentChangeViewerInfoPolicyDetails Changed whether members can see who viewed the shared file or folder.
SharedContentChangeViewerInfoPolicyDetails
Changed whether members can see who viewed the shared file or folder.
target_index Int64 Target asset index.
new_value SharedContentViewerInfoPolicy New viewer info policy.
SharedContentViewerInfoPolicy (open union)
Shared content viewer info policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedContentViewerInfoPolicy? Previous view info policy. Might be missing due to historical data gap. This field is optional.
SharedContentViewerInfoPolicy (open union)
Shared content viewer info policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
shared_content_claim_invitation_details SharedContentClaimInvitationDetails Claimed membership to a team member's shared folder.
SharedContentClaimInvitationDetails
Claimed membership to a team member's shared folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_content_link String? Shared content link. This field is optional.
shared_content_copy_details SharedContentCopyDetails Copied the shared file or folder to own Dropbox.
SharedContentCopyDetails
Copied the shared file or folder to own Dropbox.
shared_content_link String Shared content link.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
target_index Int64 Target asset index.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_download_details SharedContentDownloadDetails Downloaded the shared file or folder.
SharedContentDownloadDetails
Downloaded the shared file or folder.
shared_content_link String Shared content link.
target_index Int64 Target asset index.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_relinquish_membership_details SharedContentRelinquishMembershipDetails Left the membership of a shared file or folder.
SharedContentRelinquishMembershipDetails
Left the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_content_remove_invitee_details SharedContentRemoveInviteeDetails Removed an invitee from the membership of a shared file or folder before it was claimed.
SharedContentRemoveInviteeDetails
Removed an invitee from the membership of a shared file or folder before it was claimed.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_content_remove_link_expiry_details SharedContentRemoveLinkExpiryDetails Removed the expiry of the link for the shared file or folder.
SharedContentRemoveLinkExpiryDetails
Removed the expiry of the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_remove_link_password_details SharedContentRemoveLinkPasswordDetails Removed the password on the link for the shared file or folder.
SharedContentRemoveLinkPasswordDetails
Removed the password on the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_remove_member_details SharedContentRemoveMemberDetails Removed a user or a group from the membership of a shared file or folder.
SharedContentRemoveMemberDetails
Removed a user or a group from the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_request_access_details SharedContentRequestAccessDetails Requested to be on the membership of a shared file or folder.
SharedContentRequestAccessDetails
Requested to be on the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_content_link String? Shared content link. This field is optional.
shared_content_unshare_details SharedContentUnshareDetails Unshared a shared file or folder by clearing its membership and turning off its link.
SharedContentUnshareDetails
Unshared a shared file or folder by clearing its membership and turning off its link.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_content_view_details SharedContentViewDetails Previewed the shared file or folder.
SharedContentViewDetails
Previewed the shared file or folder.
shared_content_link String Shared content link.
target_index Int64 Target asset index.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_change_confidentiality_details SharedFolderChangeConfidentialityDetails Set or unset the confidential flag on a shared folder.
SharedFolderChangeConfidentialityDetails
Set or unset the confidential flag on a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
new_value Confidentiality New confidentiality value.
Confidentiality (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
confidential Void
non_confidential Void
previous_value Confidentiality? Previous confidentiality value. Might be missing due to historical data gap. This field is optional.
Confidentiality (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
confidential Void
non_confidential Void
shared_folder_change_link_policy_details SharedFolderChangeLinkPolicyDetails Changed who can access the shared folder via a link.
SharedFolderChangeLinkPolicyDetails
Changed who can access the shared folder via a link.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
new_value SharedFolderLinkPolicy New shared folder link policy.
SharedFolderLinkPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
members_only Void
members_and_team Void
anyone Void
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedFolderLinkPolicy? Previous shared folder link policy. Might be missing due to historical data gap. This field is optional.
SharedFolderLinkPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
members_only Void
members_and_team Void
anyone Void
shared_folder_change_member_management_policy_details SharedFolderChangeMemberManagementPolicyDetails Changed who can manage the membership of a shared folder.
SharedFolderChangeMemberManagementPolicyDetails
Changed who can manage the membership of a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
new_value SharedFolderMembershipManagementPolicy New membership management policy.
SharedFolderMembershipManagementPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
owner Void
editors Void
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedFolderMembershipManagementPolicy? Previous membership management policy. Might be missing due to historical data gap. This field is optional.
SharedFolderMembershipManagementPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
owner Void
editors Void
shared_folder_change_member_policy_details SharedFolderChangeMemberPolicyDetails Changed who can become a member of the shared folder.
SharedFolderChangeMemberPolicyDetails
Changed who can become a member of the shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
new_value SharedFolderMemberPolicy New external invite policy.
SharedFolderMemberPolicy (open union)
Policy for controlling who can become a member of a shared folder The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
anyone Void
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedFolderMemberPolicy? Previous external invite policy. Might be missing due to historical data gap. This field is optional.
SharedFolderMemberPolicy (open union)
Policy for controlling who can become a member of a shared folder The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
anyone Void
shared_folder_create_details SharedFolderCreateDetails Created a shared folder.
SharedFolderCreateDetails
Created a shared folder.
target_index Int64 Target asset index.
parent_ns_id String(pattern="[-_0-9a-zA-Z:]+")? Parent namespace ID. Might be missing due to historical data gap. This field is optional.
shared_folder_mount_details SharedFolderMountDetails Added a shared folder to own Dropbox.
SharedFolderMountDetails
Added a shared folder to own Dropbox.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_folder_transfer_ownership_details SharedFolderTransferOwnershipDetails Transferred the ownership of a shared folder to another member.
SharedFolderTransferOwnershipDetails
Transferred the ownership of a shared folder to another member.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_folder_unmount_details SharedFolderUnmountDetails Deleted a shared folder from Dropbox.
SharedFolderUnmountDetails
Deleted a shared folder from Dropbox.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_note_opened_details SharedNoteOpenedDetails Shared Paper document was opened.
SharedNoteOpenedDetails
Shared Paper document was opened.
shmodel_app_create_details ShmodelAppCreateDetails Created a link to a file using an app.
ShmodelAppCreateDetails
Created a link to a file using an app.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
token_key String? Shared link token key. This field is optional.
shmodel_create_details ShmodelCreateDetails Created a new link.
ShmodelCreateDetails
Created a new link.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
token_key String? Shared link token key. This field is optional.
shmodel_disable_details ShmodelDisableDetails Removed a link.
ShmodelDisableDetails
Removed a link.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
token_key String? Shared link token key. This field is optional.
shmodel_fb_share_details ShmodelFbShareDetails Shared a link with Facebook users.
ShmodelFbShareDetails
Shared a link with Facebook users.
sharing_non_member_recipients List of (NonTeamMemberLogInfo) Sharing non member recipients.
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
shmodel_group_share_details ShmodelGroupShareDetails Shared a link with a group.
ShmodelGroupShareDetails
Shared a link with a group.
shmodel_remove_expiration_details ShmodelRemoveExpirationDetails Removed the expiration date from a link.
ShmodelRemoveExpirationDetails
Removed the expiration date from a link.
shmodel_set_expiration_details ShmodelSetExpirationDetails Added an expiration date to a link.
ShmodelSetExpirationDetails
Added an expiration date to a link.
expiration_start_date String Expiration starting date.
expiration_days Int64 The number of days from the starting expiration date after which the link will expire.
shmodel_team_copy_details ShmodelTeamCopyDetails Added a team member's file/folder to their Dropbox from a link.
ShmodelTeamCopyDetails
Added a team member's file/folder to their Dropbox from a link.
shmodel_team_download_details ShmodelTeamDownloadDetails Downloaded a team member's file/folder from a link.
ShmodelTeamDownloadDetails
Downloaded a team member's file/folder from a link.
shmodel_team_share_details ShmodelTeamShareDetails Shared a link with team members.
ShmodelTeamShareDetails
Shared a link with team members.
shmodel_team_view_details ShmodelTeamViewDetails Opened a team member's link.
ShmodelTeamViewDetails
Opened a team member's link.
shmodel_visibility_password_details ShmodelVisibilityPasswordDetails Password-protected a link.
ShmodelVisibilityPasswordDetails
Password-protected a link.
shmodel_visibility_public_details ShmodelVisibilityPublicDetails Made a file/folder visible to anyone with the link.
ShmodelVisibilityPublicDetails
Made a file/folder visible to anyone with the link.
shmodel_visibility_team_only_details ShmodelVisibilityTeamOnlyDetails Made a file/folder visible only to team members with the link.
ShmodelVisibilityTeamOnlyDetails
Made a file/folder visible only to team members with the link.
remove_logout_url_details RemoveLogoutUrlDetails Removed single sign-on logout URL.
RemoveLogoutUrlDetails
Removed single sign-on logout URL.
previous_value String Previous single sign-on logout URL.
new_value String? New single sign-on logout URL. Might be missing due to historical data gap. This field is optional.
remove_sso_url_details RemoveSsoUrlDetails Changed the sign-out URL for SSO.
RemoveSsoUrlDetails
Changed the sign-out URL for SSO.
previous_value String Previous single sign-on logout URL.
sso_change_cert_details SsoChangeCertDetails Changed the X.509 certificate for SSO.
SsoChangeCertDetails
Changed the X.509 certificate for SSO.
certificate_details Certificate SSO certificate details.
Certificate
Certificate details.
subject String Certificate subject.
issuer String Certificate issuer.
issue_date String Certificate issue date.
expiration_date String Certificate expiration date.
serial_number String Certificate serial number.
sha1_fingerprint String Certificate sha1 fingerprint.
common_name String Certificate common name.
sso_change_login_url_details SsoChangeLoginUrlDetails Changed the sign-in URL for SSO.
SsoChangeLoginUrlDetails
Changed the sign-in URL for SSO.
previous_value String Previous single sign-on login URL.
new_value String New single sign-on login URL.
sso_change_logout_url_details SsoChangeLogoutUrlDetails Changed the sign-out URL for SSO.
SsoChangeLogoutUrlDetails
Changed the sign-out URL for SSO.
previous_value String Previous single sign-on logout URL.
new_value String? New single sign-on logout URL. Might be missing due to historical data gap. This field is optional.
sso_change_saml_identity_mode_details SsoChangeSamlIdentityModeDetails Changed the SAML identity mode for SSO.
SsoChangeSamlIdentityModeDetails
Changed the SAML identity mode for SSO.
previous_value Int64 Previous single sign-on identity mode.
new_value Int64 New single sign-on identity mode.
team_folder_change_status_details TeamFolderChangeStatusDetails Changed the archival status of a team folder.
TeamFolderChangeStatusDetails
Changed the archival status of a team folder.
new_value TeamFolderStatus New team folder status.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
archive Void
unarchive Void
previous_value TeamFolderStatus? Previous team folder status. Might be missing due to historical data gap. This field is optional.
TeamFolderStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
archive Void
unarchive Void
team_folder_create_details TeamFolderCreateDetails Created a new team folder in active status.
TeamFolderCreateDetails
Created a new team folder in active status.
team_folder_downgrade_details TeamFolderDowngradeDetails Downgraded a team folder to a regular shared folder.
TeamFolderDowngradeDetails
Downgraded a team folder to a regular shared folder.
target_index Int64 Target asset index.
team_folder_permanently_delete_details TeamFolderPermanentlyDeleteDetails Permanently deleted an archived team folder.
TeamFolderPermanentlyDeleteDetails
Permanently deleted an archived team folder.
team_folder_rename_details TeamFolderRenameDetails Renamed an active or archived team folder.
TeamFolderRenameDetails
Renamed an active or archived team folder.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
account_capture_change_policy_details AccountCaptureChangePolicyDetails Changed the account capture policy on a domain belonging to the team.
AccountCaptureChangePolicyDetails
Changed the account capture policy on a domain belonging to the team.
new_value AccountCapturePolicy New account capture policy.
AccountCapturePolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
invited_users Void
all_users Void
previous_value AccountCapturePolicy? Previous account capture policy. Might be missing due to historical data gap. This field is optional.
AccountCapturePolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
invited_users Void
all_users Void
allow_download_disabled_details AllowDownloadDisabledDetails Disabled allow downloads.
AllowDownloadDisabledDetails
Disabled allow downloads.
allow_download_enabled_details AllowDownloadEnabledDetails Enabled allow downloads.
AllowDownloadEnabledDetails
Enabled allow downloads.
data_placement_restriction_change_policy_details DataPlacementRestrictionChangePolicyDetails Set a restriction policy regarding the location of data centers where team data resides.
DataPlacementRestrictionChangePolicyDetails
Set a restriction policy regarding the location of data centers where team data resides.
previous_value PlacementRestriction Previous placement restriction.
PlacementRestriction (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
europe_only Void
none Void
new_value PlacementRestriction New placement restriction.
PlacementRestriction (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
europe_only Void
none Void
data_placement_restriction_satisfy_policy_details DataPlacementRestrictionSatisfyPolicyDetails Satisfied a previously set restriction policy regarding the location of data centers where team data resides (i.e. all data have been migrated according to the restriction placed).
DataPlacementRestrictionSatisfyPolicyDetails
Satisfied a previously set restriction policy regarding the location of data centers where team data resides (i.e. all data have been migrated according to the restriction placed).
placement_restriction PlacementRestriction Placement restriction.
PlacementRestriction (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
europe_only Void
none Void
device_approvals_change_desktop_policy_details DeviceApprovalsChangeDesktopPolicyDetails Set or removed a limit on the number of computers each team member can link to their work Dropbox account.
DeviceApprovalsChangeDesktopPolicyDetails
Set or removed a limit on the number of computers each team member can link to their work Dropbox account.
new_value DeviceApprovalsPolicy? New desktop device approvals policy. Might be missing due to historical data gap. This field is optional.
DeviceApprovalsPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
unlimited Void
limited Void
previous_value DeviceApprovalsPolicy? Previous desktop device approvals policy. Might be missing due to historical data gap. This field is optional.
DeviceApprovalsPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
unlimited Void
limited Void
device_approvals_change_mobile_policy_details DeviceApprovalsChangeMobilePolicyDetails Set or removed a limit on the number of mobiles devices each team member can link to their work Dropbox account.
DeviceApprovalsChangeMobilePolicyDetails
Set or removed a limit on the number of mobiles devices each team member can link to their work Dropbox account.
new_value DeviceApprovalsPolicy? New mobile device approvals policy. Might be missing due to historical data gap. This field is optional.
DeviceApprovalsPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
unlimited Void
limited Void
previous_value DeviceApprovalsPolicy? Previous mobile device approvals policy. Might be missing due to historical data gap. This field is optional.
DeviceApprovalsPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
unlimited Void
limited Void
device_approvals_change_overage_action_details DeviceApprovalsChangeOverageActionDetails Changed the action taken when a team member is already over the limits (e.g when they join the team, an admin lowers limits, etc.).
DeviceApprovalsChangeOverageActionDetails
Changed the action taken when a team member is already over the limits (e.g when they join the team, an admin lowers limits, etc.).
new_value DeviceApprovalsRolloutPolicy? New over the limits policy. Might be missing due to historical data gap. This field is optional.
DeviceApprovalsRolloutPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
remove_oldest Void
remove_all Void
add_exception Void
previous_value DeviceApprovalsRolloutPolicy? Previous over the limit policy. Might be missing due to historical data gap. This field is optional.
DeviceApprovalsRolloutPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
remove_oldest Void
remove_all Void
add_exception Void
device_approvals_change_unlink_action_details DeviceApprovalsChangeUnlinkActionDetails Changed the action taken with respect to approval limits when a team member unlinks an approved device.
DeviceApprovalsChangeUnlinkActionDetails
Changed the action taken with respect to approval limits when a team member unlinks an approved device.
new_value DeviceUnlinkPolicy? New device unlink policy. Might be missing due to historical data gap. This field is optional.
DeviceUnlinkPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
remove Void
keep Void
previous_value DeviceUnlinkPolicy? Previous device unlink policy. Might be missing due to historical data gap. This field is optional.
DeviceUnlinkPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
remove Void
keep Void
emm_add_exception_details EmmAddExceptionDetails Added an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
EmmAddExceptionDetails
Added an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
emm_change_policy_details EmmChangePolicyDetails Enabled or disabled enterprise mobility management for team members.
EmmChangePolicyDetails
Enabled or disabled enterprise mobility management for team members.
new_value EmmPolicy New enterprise mobility management policy.
EmmPolicy (open union)
Enterprise mobility management policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
optional Void
required Void
previous_value EmmPolicy? Previous enterprise mobility management policy. Might be missing due to historical data gap. This field is optional.
EmmPolicy (open union)
Enterprise mobility management policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
optional Void
required Void
emm_remove_exception_details EmmRemoveExceptionDetails Removed an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
EmmRemoveExceptionDetails
Removed an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
extended_version_history_change_policy_details ExtendedVersionHistoryChangePolicyDetails Accepted or opted out of extended version history.
ExtendedVersionHistoryChangePolicyDetails
Accepted or opted out of extended version history.
new_value ExtendedVersionHistoryPolicy New extended version history policy.
ExtendedVersionHistoryPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
limited Void
unlimited Void
previous_value ExtendedVersionHistoryPolicy? Previous extended version history policy. Might be missing due to historical data gap. This field is optional.
ExtendedVersionHistoryPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
limited Void
unlimited Void
file_comments_change_policy_details FileCommentsChangePolicyDetails Enabled or disabled commenting on team files.
FileCommentsChangePolicyDetails
Enabled or disabled commenting on team files.
new_value FileCommentsPolicy New commenting on team files policy.
FileCommentsPolicy (open union)
File comments policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value FileCommentsPolicy? Previous commenting on team files policy. Might be missing due to historical data gap. This field is optional.
FileCommentsPolicy (open union)
File comments policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
file_requests_change_policy_details FileRequestsChangePolicyDetails Enabled or disabled file requests.
FileRequestsChangePolicyDetails
Enabled or disabled file requests.
new_value FileRequestsPolicy New file requests policy.
FileRequestsPolicy (open union)
File requests policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value FileRequestsPolicy? Previous file requests policy. Might be missing due to historical data gap. This field is optional.
FileRequestsPolicy (open union)
File requests policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
file_requests_emails_enabled_details FileRequestsEmailsEnabledDetails Enabled file request emails for everyone.
FileRequestsEmailsEnabledDetails
Enabled file request emails for everyone.
file_requests_emails_restricted_to_team_only_details FileRequestsEmailsRestrictedToTeamOnlyDetails Allowed file request emails for the team.
FileRequestsEmailsRestrictedToTeamOnlyDetails
Allowed file request emails for the team.
google_sso_change_policy_details GoogleSsoChangePolicyDetails Enabled or disabled Google single sign-on for the team.
GoogleSsoChangePolicyDetails
Enabled or disabled Google single sign-on for the team.
new_value GoogleSsoPolicy New Google single sign-on policy.
GoogleSsoPolicy (open union)
Google SSO policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value GoogleSsoPolicy? Previous Google single sign-on policy. Might be missing due to historical data gap. This field is optional.
GoogleSsoPolicy (open union)
Google SSO policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
group_user_management_change_policy_details GroupUserManagementChangePolicyDetails Changed who can create groups.
GroupUserManagementChangePolicyDetails
Changed who can create groups.
new_value GroupUserManagementPolicy New group users management policy.
GroupUserManagementPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
all_users Void
only_admins Void
previous_value GroupUserManagementPolicy? Previous group users management policy. Might be missing due to historical data gap. This field is optional.
GroupUserManagementPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
all_users Void
only_admins Void
member_requests_change_policy_details MemberRequestsChangePolicyDetails Changed whether users can find the team when not invited.
MemberRequestsChangePolicyDetails
Changed whether users can find the team when not invited.
new_value MemberRequestsPolicy New member change requests policy.
MemberRequestsPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
require_approval Void
auto_approval Void
previous_value MemberRequestsPolicy? Previous member change requests policy. Might be missing due to historical data gap. This field is optional.
MemberRequestsPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
require_approval Void
auto_approval Void
member_space_limits_add_exception_details MemberSpaceLimitsAddExceptionDetails Added an exception for one or more team members to bypass space limits imposed by policy.
MemberSpaceLimitsAddExceptionDetails
Added an exception for one or more team members to bypass space limits imposed by policy.
member_space_limits_change_policy_details MemberSpaceLimitsChangePolicyDetails Changed the storage limits applied to team members by policy.
MemberSpaceLimitsChangePolicyDetails
Changed the storage limits applied to team members by policy.
previous_value SpaceLimitsLevel Previous storage limits policy.
SpaceLimitsLevel (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
generous Void
moderate Void
no_limit Void
strict Void
new_value SpaceLimitsLevel New storage limits policy.
SpaceLimitsLevel (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
generous Void
moderate Void
no_limit Void
strict Void
member_space_limits_remove_exception_details MemberSpaceLimitsRemoveExceptionDetails Removed an exception for one or more team members to bypass space limits imposed by policy.
MemberSpaceLimitsRemoveExceptionDetails
Removed an exception for one or more team members to bypass space limits imposed by policy.
member_suggestions_change_policy_details MemberSuggestionsChangePolicyDetails Enabled or disabled the option for team members to suggest new members to add to the team.
MemberSuggestionsChangePolicyDetails
Enabled or disabled the option for team members to suggest new members to add to the team.
new_value MemberSuggestionsPolicy New team member suggestions policy.
MemberSuggestionsPolicy (open union)
Member suggestions policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value MemberSuggestionsPolicy? Previous team member suggestions policy. Might be missing due to historical data gap. This field is optional.
MemberSuggestionsPolicy (open union)
Member suggestions policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
microsoft_office_addin_change_policy_details MicrosoftOfficeAddinChangePolicyDetails Enabled or disabled the Microsoft Office add-in, which lets team members save files to Dropbox directly from Microsoft Office.
MicrosoftOfficeAddinChangePolicyDetails
Enabled or disabled the Microsoft Office add-in, which lets team members save files to Dropbox directly from Microsoft Office.
new_value MicrosoftOfficeAddinPolicy New Microsoft Office addin policy.
MicrosoftOfficeAddinPolicy (open union)
Microsoft Office addin policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value MicrosoftOfficeAddinPolicy? Previous Microsoft Office addin policy. Might be missing due to historical data gap. This field is optional.
MicrosoftOfficeAddinPolicy (open union)
Microsoft Office addin policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
network_control_change_policy_details NetworkControlChangePolicyDetails Enabled or disabled network control.
NetworkControlChangePolicyDetails
Enabled or disabled network control.
new_value NetworkControlPolicy New network control policy.
NetworkControlPolicy (open union)
Network control policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value NetworkControlPolicy? Previous network control policy. Might be missing due to historical data gap. This field is optional.
NetworkControlPolicy (open union)
Network control policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
paper_change_deployment_policy_details PaperChangeDeploymentPolicyDetails Changed whether Dropbox Paper, when enabled, is deployed to all teams or to specific members of the team.
PaperChangeDeploymentPolicyDetails
Changed whether Dropbox Paper, when enabled, is deployed to all teams or to specific members of the team.
new_value PaperDeploymentPolicy New Dropbox Paper deployment policy.
PaperDeploymentPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
partial Void
full Void
previous_value PaperDeploymentPolicy? Previous Dropbox Paper deployment policy. Might be missing due to historical data gap. This field is optional.
PaperDeploymentPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
partial Void
full Void
paper_change_member_policy_details PaperChangeMemberPolicyDetails Changed whether team members can share Paper documents externally (i.e. outside the team), and if so, whether they should be accessible only by team members or anyone by default.
PaperChangeMemberPolicyDetails
Changed whether team members can share Paper documents externally (i.e. outside the team), and if so, whether they should be accessible only by team members or anyone by default.
new_value PaperMemberPolicy New paper external accessibility policy.
PaperMemberPolicy (open union)
Policy for controlling if team members can share Paper documents externally. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
default_team_only Void
default_anyone Void
previous_value PaperMemberPolicy? Previous paper external accessibility policy. Might be missing due to historical data gap. This field is optional.
PaperMemberPolicy (open union)
Policy for controlling if team members can share Paper documents externally. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
default_team_only Void
default_anyone Void
paper_change_policy_details PaperChangePolicyDetails Enabled or disabled Dropbox Paper for the team.
PaperChangePolicyDetails
Enabled or disabled Dropbox Paper for the team.
new_value PaperPolicy New Dropbox Paper policy.
PaperPolicy (open union)
Policy for enabling or disabling Dropbox Paper for the team. The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value PaperPolicy? Previous Dropbox Paper policy. Might be missing due to historical data gap. This field is optional.
PaperPolicy (open union)
Policy for enabling or disabling Dropbox Paper for the team. The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
permanent_delete_change_policy_details PermanentDeleteChangePolicyDetails Enabled or disabled the ability of team members to permanently delete content.
PermanentDeleteChangePolicyDetails
Enabled or disabled the ability of team members to permanently delete content.
new_value ContentPermanentDeletePolicy New permanent delete content policy.
ContentPermanentDeletePolicy (open union)
Policy for pemanent content deletion The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value ContentPermanentDeletePolicy? Previous permanent delete content policy. Might be missing due to historical data gap. This field is optional.
ContentPermanentDeletePolicy (open union)
Policy for pemanent content deletion The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
sharing_change_folder_join_policy_details SharingChangeFolderJoinPolicyDetails Changed whether team members can join shared folders owned externally (i.e. outside the team).
SharingChangeFolderJoinPolicyDetails
Changed whether team members can join shared folders owned externally (i.e. outside the team).
new_value SharingFolderJoinPolicy New external join policy.
SharingFolderJoinPolicy (open union)
Policy for controlling if team members can join shared folders owned by non team members. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
anyone Void
previous_value SharingFolderJoinPolicy? Previous external join policy. Might be missing due to historical data gap. This field is optional.
SharingFolderJoinPolicy (open union)
Policy for controlling if team members can join shared folders owned by non team members. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
anyone Void
sharing_change_link_policy_details SharingChangeLinkPolicyDetails Changed whether team members can share links externally (i.e. outside the team), and if so, whether links should be accessible only by team members or anyone by default.
SharingChangeLinkPolicyDetails
Changed whether team members can share links externally (i.e. outside the team), and if so, whether links should be accessible only by team members or anyone by default.
new_value SharingLinkPolicy New external link accessibility policy.
SharingLinkPolicy (open union)
Policy for controlling if team members can share links externally The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
default_team_only Void
default_anyone Void
previous_value SharingLinkPolicy? Previous external link accessibility policy. Might be missing due to historical data gap. This field is optional.
SharingLinkPolicy (open union)
Policy for controlling if team members can share links externally The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
default_team_only Void
default_anyone Void
sharing_change_member_policy_details SharingChangeMemberPolicyDetails Changed whether team members can share files and folders externally (i.e. outside the team).
SharingChangeMemberPolicyDetails
Changed whether team members can share files and folders externally (i.e. outside the team).
new_value SharingMemberPolicy New external invite policy.
SharingMemberPolicy (open union)
External sharing policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
anyone Void
previous_value SharingMemberPolicy? Previous external invite policy. Might be missing due to historical data gap. This field is optional.
SharingMemberPolicy (open union)
External sharing policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_only Void
anyone Void
smart_sync_change_policy_details SmartSyncChangePolicyDetails Changed the default Smart Sync policy for team members.
SmartSyncChangePolicyDetails
Changed the default Smart Sync policy for team members.
new_value SmartSyncPolicy New smart sync policy.
SmartSyncPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
local_only Void
synced Void
previous_value SmartSyncPolicy? Previous smart sync policy. Might be missing due to historical data gap. This field is optional.
SmartSyncPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
local_only Void
synced Void
smart_sync_not_opt_out_details SmartSyncNotOptOutDetails Opted team into Smart Sync.
SmartSyncNotOptOutDetails
Opted team into Smart Sync.
previous_value SmartSyncOptOutPolicy Previous Smart Sync opt out policy.
SmartSyncOptOutPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
opted_out Void
default Void
new_value SmartSyncOptOutPolicy New Smart Sync opt out policy.
SmartSyncOptOutPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
opted_out Void
default Void
smart_sync_opt_out_details SmartSyncOptOutDetails Opted team out of Smart Sync.
SmartSyncOptOutDetails
Opted team out of Smart Sync.
previous_value SmartSyncOptOutPolicy Previous Smart Sync opt out policy.
SmartSyncOptOutPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
opted_out Void
default Void
new_value SmartSyncOptOutPolicy New Smart Sync opt out policy.
SmartSyncOptOutPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
opted_out Void
default Void
sso_change_policy_details SsoChangePolicyDetails Change the single sign-on policy for the team.
SsoChangePolicyDetails
Change the single sign-on policy for the team.
new_value SsoPolicy New single sign-on policy.
SsoPolicy (open union)
SSO policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
optional Void
required Void
previous_value SsoPolicy? Previous single sign-on policy. Might be missing due to historical data gap. This field is optional.
SsoPolicy (open union)
SSO policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
optional Void
required Void
tfa_change_policy_details TfaChangePolicyDetails Change two-step verification policy for the team.
TfaChangePolicyDetails
Change two-step verification policy for the team.
new_value TfaPolicy New change policy.
TfaPolicy (open union)
Two factor authentication policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
optional Void
required Void
previous_value TfaPolicy? Previous change policy. Might be missing due to historical data gap. This field is optional.
TfaPolicy (open union)
Two factor authentication policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
optional Void
required Void
two_account_change_policy_details TwoAccountChangePolicyDetails Enabled or disabled the option for team members to link a personal Dropbox account in addition to their work account to the same computer.
TwoAccountChangePolicyDetails
Enabled or disabled the option for team members to link a personal Dropbox account in addition to their work account to the same computer.
new_value TwoAccountPolicy New two account policy.
TwoAccountPolicy (open union)
Policy for pairing personal account to work account The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
previous_value TwoAccountPolicy? Previous two account policy. Might be missing due to historical data gap. This field is optional.
TwoAccountPolicy (open union)
Policy for pairing personal account to work account The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
web_sessions_change_fixed_length_policy_details WebSessionsChangeFixedLengthPolicyDetails Changed how long team members can stay signed in to Dropbox on the web.
WebSessionsChangeFixedLengthPolicyDetails
Changed how long team members can stay signed in to Dropbox on the web.
new_value SessionsManagementSessionLengthPolicy New session length policy.
SessionsManagementSessionLengthPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
day_1 Void
day_7 Void
day_14 Void
month_1 Void
month_3 Void
month_6 Void
year_1 Void
previous_value SessionsManagementSessionLengthPolicy Previous session length policy.
SessionsManagementSessionLengthPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
day_1 Void
day_7 Void
day_14 Void
month_1 Void
month_3 Void
month_6 Void
year_1 Void
web_sessions_change_idle_length_policy_details WebSessionsChangeIdleLengthPolicyDetails Changed how long team members can be idle while signed in to Dropbox on the web.
WebSessionsChangeIdleLengthPolicyDetails
Changed how long team members can be idle while signed in to Dropbox on the web.
new_value SessionsManagementIdleLengthPolicy New idle length policy.
SessionsManagementIdleLengthPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
none Void
minute_10 Void
minute_30 Void
hour_1 Void
hour_8 Void
hour_24 Void
hour_48 Void
previous_value SessionsManagementIdleLengthPolicy Previous idle length policy.
SessionsManagementIdleLengthPolicy (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
none Void
minute_10 Void
minute_30 Void
hour_1 Void
hour_8 Void
hour_24 Void
hour_48 Void
team_profile_add_logo_details TeamProfileAddLogoDetails Added a team logo to be displayed on shared link headers.
TeamProfileAddLogoDetails
Added a team logo to be displayed on shared link headers.
team_profile_change_logo_details TeamProfileChangeLogoDetails Changed the team logo to be displayed on shared link headers.
TeamProfileChangeLogoDetails
Changed the team logo to be displayed on shared link headers.
team_profile_change_name_details TeamProfileChangeNameDetails Changed the team name.
TeamProfileChangeNameDetails
Changed the team name.
new_value TeamName New team name.
TeamName
Team name details
team_display_name String Team's display name.
team_legal_name String Team's legal name.
previous_value TeamName? Previous teams name. Might be missing due to historical data gap. This field is optional.
TeamName
Team name details
team_display_name String Team's display name.
team_legal_name String Team's legal name.
team_profile_remove_logo_details TeamProfileRemoveLogoDetails Removed the team logo to be displayed on shared link headers.
TeamProfileRemoveLogoDetails
Removed the team logo to be displayed on shared link headers.
tfa_add_backup_phone_details TfaAddBackupPhoneDetails Added a backup phone for two-step verification.
TfaAddBackupPhoneDetails
Added a backup phone for two-step verification.
tfa_add_security_key_details TfaAddSecurityKeyDetails Added a security key for two-step verification.
TfaAddSecurityKeyDetails
Added a security key for two-step verification.
tfa_change_backup_phone_details TfaChangeBackupPhoneDetails Changed the backup phone for two-step verification.
TfaChangeBackupPhoneDetails
Changed the backup phone for two-step verification.
tfa_change_status_details TfaChangeStatusDetails Enabled, disabled or changed the configuration for two-step verification.
TfaChangeStatusDetails
Enabled, disabled or changed the configuration for two-step verification.
new_value TfaConfiguration The new two factor authentication configuration.
TfaConfiguration (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
sms Void
authenticator Void
previous_value TfaConfiguration? The previous two factor authentication configuration. Might be missing due to historical data gap. This field is optional.
TfaConfiguration (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
sms Void
authenticator Void
used_rescue_code Boolean? Used two factor authentication code. This field is optional.
tfa_remove_backup_phone_details TfaRemoveBackupPhoneDetails Removed the backup phone for two-step verification.
TfaRemoveBackupPhoneDetails
Removed the backup phone for two-step verification.
tfa_remove_security_key_details TfaRemoveSecurityKeyDetails Removed a security key for two-step verification.
TfaRemoveSecurityKeyDetails
Removed a security key for two-step verification.
tfa_reset_details TfaResetDetails Reset two-step verification for team member.
TfaResetDetails
Reset two-step verification for team member.
missing_details MissingDetails Hints that this event was returned with missing details due to an internal error.
MissingDetails
An indication that an event was returned with missing details
origin OriginLogInfo? The origin from which the actor performed the action including information about host, ip address, location, session, etc. If the action was performed programmatically via the API the origin represents the API client. This field is optional.
OriginLogInfo
The origin from which the actor performed the action.
access_method AccessMethodLogInfo The method that was used to perform the action.
AccessMethodLogInfo (open union)
Indicates the method in which the action was performed. The value will be one of the following datatypes. New values may be introduced as our API evolves.
end_user SessionLogInfo End user session details.
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.
sign_in_as WebSessionLogInfo Sign in as session details.
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
content_manager WebSessionLogInfo Content manager session details.
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
admin_console WebSessionLogInfo Admin console session details.
WebSessionLogInfo
Web session.
session_id String? Session ID. Might be missing due to historical data gap. This field is optional.
api ApiSessionLogInfo Api session details.
ApiSessionLogInfo
Api session.
request_id String Api request ID.
geo_location GeoLocationLogInfo? Geographic location details. This field is optional.
GeoLocationLogInfo
Geographic location details.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$") IP address.
city String? City name. This field is optional.
region String? Region name. This field is optional.
country String? Country code. This field is optional.
host HostLogInfo? Host details. This field is optional.
HostLogInfo
Host details.
host_id UInt64? Host ID. Might be missing due to historical data gap. This field is optional.
host_name String? Host name. Might be missing due to historical data gap. This field is optional.
participants List of (ParticipantLogInfo)? Zero or more users and/or groups that are affected by the action. Note that this list doesn't include any actors or users in context. This field is optional.
ParticipantLogInfo (open union)
A user or group The value will be one of the following datatypes. New values may be introduced as our API evolves.
user UserLogInfo User details.
UserLogInfo (datatype with subtypes)
User's logged information. This datatype will be one of the following subtypes:
team_member TeamMemberLogInfo
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
group GroupLogInfo Group details.
GroupLogInfo
Group's logged information.
display_name String The name of this group.
group_id String? The unique id of this group. Might be missing due to historical data gap. This field is optional.
external_id String? External group ID. Might be missing due to historical data gap. This field is optional.
assets List of (AssetLogInfo)? Zero or more content assets involved in the action. Currently these include Dropbox files and folders but in the future we might add other asset types such as Paper documents, folders, projects, etc. This field is optional.
AssetLogInfo (open union)
Asset details. The value will be one of the following datatypes. New values may be introduced as our API evolves.
file FileLogInfo File's details.
FileLogInfo
File's logged information.
path PathLogInfo Path relative to event context.
PathLogInfo
Path's details.
namespace_relative NamespaceRelativePathLogInfo Path relative to the namespace containing the content.
NamespaceRelativePathLogInfo
Namespace relative path details.
ns_id String(pattern="[-_0-9a-zA-Z:]+")? Namespace ID. Might be missing due to historical data gap. This field is optional.
relative_path String(pattern="/(.|[\r\n])*")? A path relative to the specified namespace ID. Might be missing due to historical data gap. This field is optional.
contextual String(pattern="/(.|[\r\n])*")? Fully qualified path relative to event's context. Might be missing due to historical data gap. This field is optional.
display_name String? Display name. Might be missing due to historical data gap. This field is optional.
file_id String? Unique ID. Might be missing due to historical data gap. This field is optional.
folder FolderLogInfo Folder's details.
FolderLogInfo
Folder's logged information.
path PathLogInfo Path relative to event context.
PathLogInfo
Path's details.
namespace_relative NamespaceRelativePathLogInfo Path relative to the namespace containing the content.
NamespaceRelativePathLogInfo
Namespace relative path details.
ns_id String(pattern="[-_0-9a-zA-Z:]+")? Namespace ID. Might be missing due to historical data gap. This field is optional.
relative_path String(pattern="/(.|[\r\n])*")? A path relative to the specified namespace ID. Might be missing due to historical data gap. This field is optional.
contextual String(pattern="/(.|[\r\n])*")? Fully qualified path relative to event's context. Might be missing due to historical data gap. This field is optional.
display_name String? Display name. Might be missing due to historical data gap. This field is optional.
file_id String? Unique ID. Might be missing due to historical data gap. This field is optional.
paper_document PaperDocumentLogInfo Paper docuement's details.
PaperDocumentLogInfo
Paper document's logged information.
doc_id String Papers document Id.
doc_title String Paper document title.
paper_folder PaperFolderLogInfo Paper folder's details.
PaperFolderLogInfo
Paper folder's logged information.
folder_id String Papers folder Id.
folder_name String Paper folder name.
cursor String Pass the cursor into get_events/continue to obtain additional events.
has_more Boolean Is true if there are additional events that have not been returned yet. An additional call to get_events/continue can retrieve them.
Errors
{
    "error_summary": "account_id_not_found/...",
    "error": {
        ".tag": "account_id_not_found"
    }
}
Example: account_id_not_found
{
    "error_summary": "account_id_not_found/...",
    "error": {
        ".tag": "account_id_not_found"
    }
}
Example: invalid_time_range
{
    "error_summary": "invalid_time_range/...",
    "error": {
        ".tag": "invalid_time_range"
    }
}
Example: other
{
    "error_summary": "other/...",
    "error": {
        ".tag": "other"
    }
}
GetTeamEventsError (open union)
Errors that can be raised when calling get_events. The value will be one of the following datatypes. New values may be introduced as our API evolves.
account_id_not_found Void No user found matching the provided account_id.
invalid_time_range Void Invalid time range.

/get_events/continue

PREVIEW - may change or disappear without notice
Description

Once a cursor has been retrieved from get_events, use this to paginate through all events.
Permission : Team Auditing.

URL Structure
https://api.dropboxapi.com/2/team_log/get_events/continue
Authentication
Team Authentication
Endpoint format
RPC
Example
Get access token for:
curl -X POST https://api.dropboxapi.com/2/team_log/get_events/continue \
    --header "Authorization: Bearer " \
    --header "Content-Type: application/json" \
    --data "{\"cursor\": \"ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu\"}"
Parameters
{
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu"
}
GetTeamEventsContinueArg
cursor String Indicates from what point to get the next set of events.
Returns
{
    "events": [
        {
            "timestamp": "2017-01-25T15:51:30Z",
            "event_categories": [
                {
                    ".tag": "sharing"
                }
            ],
            "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"
                }
            },
            "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"
            },
            "event_type": {
                ".tag": "shared_content_download"
            },
            "details": {
                ".tag": "shared_content_download_details",
                "shared_content_link": "abc",
                "target_index": 3,
                "sharing_permission": "abc"
            },
            "origin": {
                "access_method": {
                    ".tag": "end_user",
                    "end_user": {
                        ".tag": "web",
                        "session_id": "dbwsid:123456789012345678901234567890123456789"
                    }
                },
                "geo_location": {
                    "ip_address": "10.1.1.100",
                    "city": "San Francisco",
                    "region": "California",
                    "country": "US"
                },
                "host": {
                    "host_id": 3,
                    "host_name": "host.acmecorp.com"
                }
            },
            "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"
                    }
                }
            ],
            "assets": [
                {
                    ".tag": "file",
                    "path": {
                        "namespace_relative": {
                            "ns_id": "1234",
                            "relative_path": "/Contract Work/Product Design"
                        },
                        "contextual": "/Contract Work/Product Design"
                    },
                    "display_name": "reports.xls",
                    "file_id": "id:jQKLsZFQImAAAAAAEZAAQt"
                }
            ]
        }
    ],
    "cursor": "ZtkX9_EHj3x7PMkVuFIhwKYXEpwpLwyxp9vMKomUhllil9q7eWiAu",
    "has_more": false
}
GetTeamEventsResult
events List of (TeamEvent) List of events.
TeamEvent
An audit log event.
timestamp Timestamp(format="%Y-%m-%dT%H:%M:%SZ") The Dropbox timestamp representing when the action was taken.
event_categories List of (EventCategory, min_items=1) One or more categories 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.
account_capture Void Events that have to do with account capture and invite enforcement on team-owned domains.
administration Void Events that relate to team and team member account administration or team administration. Note that these actions are not necessarily performed by team admins. They might also be performed by Dropbox Support or System or by team members on their own accounts.
apps Void Events that apply to management of linked apps.
authentication Void Events that apply to user authentication in some way.
comments Void Events that have to do with comments on files and Paper documents.
content_access Void Events that apply to changes how people can access content on Dropbox as well as actions that represent actually accessing content.
devices Void Events that apply to linked devices on mobile, desktop and Web platforms.
device_approvals Void Events that concern device approvals and device management.
domains Void Events that involve domain management feature: domain verification, invite enforcement and account capture.
emm Void Events that involve enterprise mobility management and the Dropbox EMM app.
errors Void Events that mark some type of unexpected outcome.
files Void Events that mark a user's interaction with files and folders on Dropbox.
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.
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.
sessions Void Events that mark the beginning or end of sessions as well as those that apply to an ongoing session.
shared_files Void Events that specifically apply to shared files.
shared_folders Void Events that specifically apply to shared folders.
shared_links Void Events that specifically apply to link sharing.
sharing Void Events that apply to all types of sharing and collaboration.
sharing_policies Void Events that concern policies that affect sharing - both at the team level and at the folder level.
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.
actor ActorLogInfo The entity who actually performed the action.
ActorLogInfo (open union)
The entity who performed the action. The value will be one of the following datatypes. New values may be introduced as our API evolves.
user UserLogInfo The user who did the action.
UserLogInfo (datatype with subtypes)
User's logged information. This datatype will be one of the following subtypes:
team_member TeamMemberLogInfo
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
admin UserLogInfo The admin who did the action.
UserLogInfo (datatype with subtypes)
User's logged information. This datatype will be one of the following subtypes:
team_member TeamMemberLogInfo
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
app AppLogInfo The application who did the action.
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.
reseller ResellerLogInfo Action done by reseller.
ResellerLogInfo
Reseller information.
reseller_name String Reseller name.
reseller_id String Reseller ID.
dropbox Void Action done by Dropbox.
involve_non_team_member Boolean True if the action involved a non team member either as the actor or as one of the affected users.
context ContextLogInfo The user or team on whose behalf the actor performed the action.
ContextLogInfo (open union)
The primary entity on which the action was done. The value will be one of the following datatypes. New values may be introduced as our API evolves.
team_member TeamMemberLogInfo Action was done on behalf of a team member.
TeamMemberLogInfo
Team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team_member_id String? Team member ID. Might be missing due to historical data gap. This field is optional.
member_external_id String(max_length=64)? Team member external ID. This field is optional.
non_team_member NonTeamMemberLogInfo Action was done on behalf of a non team member.
NonTeamMemberLogInfo
Non team member's logged information.
account_id String(min_length=40, max_length=40)? User unique ID. Might be missing due to historical data gap. This field is optional.
display_name String(min_length=1, pattern="[^/:?*<>"|]*")? User display name. Might be missing due to historical data gap. This field is optional.
email String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? User email address. Might be missing due to historical data gap. This field is optional.
team Void Action was done on behalf of the team.
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.
member_change_membership_type Void Changed the membership type (limited vs full) for team member.
member_permanently_delete_account_contents Void Permanently deleted contents of a removed team member account.
member_space_limits_change_status Void Changed the status with respect to whether the team member is under or over storage quota specified by policy.
member_transfer_account_contents Void Transferred contents of a removed team member account to another member.
paper_enabled_users_group_addition Void Users added to Paper enabled users list.
paper_enabled_users_group_removal Void Users removed from Paper enabled users list.
paper_external_view_allow Void Paper external sharing policy changed: anyone. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_external_view_default_team Void Paper external sharing policy changed: default team. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_external_view_forbid Void Paper external sharing policy changed: team-only. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_external_invite_warn Void Admin settings: team members see a warning before sharing folders outside the team (DEPRECATED FEATURE). This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
team_merge Void Merged the team into another team.
app_link_team Void Linked an app for team.
app_link_user Void Linked an app for team member.
app_unlink_team Void Unlinked an app for team.
app_unlink_user Void Unlinked an app for team member.
device_change_ip_desktop Void IP address associated with active desktop session changed.
device_change_ip_mobile Void IP address associated with active mobile session changed.
device_change_ip_web Void IP address associated with active Web session changed.
device_delete_on_unlink_fail Void Failed to delete all files from an unlinked device.
device_delete_on_unlink_success Void Deleted all files from an unlinked device.
device_link_fail Void Failed to link a device.
device_link_success Void Linked a device.
device_management_disabled Void Disable Device Management. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
device_management_enabled Void Enable Device Management. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
device_unlink Void Disconnected a device.
emm_refresh_auth_token Void Refreshed the auth token used for setting up enterprise mobility management.
account_capture_change_availability Void Granted or revoked the option to enable account capture on domains belonging to the team.
account_capture_migrate_account Void Account captured user migrated their account to the team.
account_capture_relinquish_account Void Account captured user relinquished their account by changing the email address associated with it.
disabled_domain_invites Void Disabled domain invites. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
domain_invites_approve_request_to_join_team Void Approved a member's request to join the team.
domain_invites_decline_request_to_join_team Void Declined a user's request to join the team.
domain_invites_email_existing_users Void Sent domain invites to existing domain accounts.
domain_invites_request_to_join_team Void Asked to join the team.
domain_invites_set_invite_new_user_pref_to_no Void Turned off u201cAutomatically invite new usersu201d. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
domain_invites_set_invite_new_user_pref_to_yes Void Turned on u201cAutomatically invite new usersu201d. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
domain_verification_add_domain_fail Void Failed to verify a domain belonging to the team.
domain_verification_add_domain_success Void Verified a domain belonging to the team.
domain_verification_remove_domain Void Removed a domain from the list of verified domains belonging to the team.
enabled_domain_invites Void Enabled domain invites. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
create_folder Void Created folders. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
file_add Void Added files and/or folders.
file_copy Void Copied files and/or folders.
file_delete Void Deleted files and/or folders.
file_download Void Downloaded files and/or folders.
file_edit Void Edited files.
file_get_copy_reference Void Create a copy reference to a file or folder.
file_move Void Moved files and/or folders.
file_permanently_delete Void Permanently deleted files and/or folders.
file_preview Void Previewed files and/or folders.
file_rename Void Renamed files and/or folders.
file_restore Void Restored deleted files and/or folders.
file_revert Void Reverted files to a previous version.
file_rollback_changes Void Rolled back file change location changes.
file_save_copy_reference Void Save a file or folder using a copy reference.
file_request_add_deadline Void Added a deadline to a file request.
file_request_change_folder Void Changed the file request folder.
file_request_change_title Void Change the file request title.
file_request_close Void Closed a file request.
file_request_create Void Created a file request.
file_request_receive_file Void Received files for a file request.
file_request_remove_deadline Void Removed the file request deadline.
file_request_send Void Sent file request to users via email.
group_add_external_id Void Added an external ID for group.
group_add_member Void Added team members to a group.
group_change_external_id Void Changed the external ID for group.
group_change_management_type Void Changed group management type.
group_change_member_role Void Changed the manager permissions belonging to a group member.
group_create Void Created a group.
group_delete Void Deleted a group.
group_description_updated Void Updated a group.
group_join_policy_updated Void Updated a group join policy.
group_moved Void Moved a group. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
group_remove_external_id Void Removed the external ID for group.
group_remove_member Void Removed team members from a group.
group_rename Void Renamed a group.
emm_login_success Void Signed in using the Dropbox EMM app.
logout Void Signed out.
password_login_fail Void Failed to sign in using a password.
password_login_success Void Signed in using a password.
reseller_support_session_end Void Ended reseller support session.
reseller_support_session_start Void Started reseller support session.
sign_in_as_session_end Void Ended admin sign-in-as session.
sign_in_as_session_start Void Started admin sign-in-as session.
sso_login_fail Void Failed to sign in using SSO.
member_add_name Void Set team member name when joining team.
member_change_email Void Changed team member email address.
member_change_name Void Changed team member name.
member_change_role Void Change the admin permissions belonging to team member.
member_change_status Void Changed the membership status of a team member.
member_suggest Void Suggested a new team member to be added to the team.
paper_content_add_member Void Added users to the membership of a Paper doc or folder.
paper_content_add_to_folder Void Added Paper doc or folder to a folder.
paper_content_archive Void Archived Paper doc or folder.
paper_content_change_subscription Void Followed or unfollowed a Paper doc or folder.
paper_content_create Void Created a Paper doc or folder.
paper_content_permanently_delete Void Permanently deleted a Paper doc or folder.
paper_content_remove_from_folder Void Removed Paper doc or folder from a folder.
paper_content_remove_member Void Removed a user from the membership of a Paper doc or folder.
paper_content_rename Void Renamed Paper doc or folder.
paper_content_restore Void Restored an archived Paper doc or folder.
paper_doc_add_comment Void Added a Paper doc comment.
paper_doc_change_member_role Void Changed the access type of a Paper doc member.
paper_doc_change_sharing_policy Void Changed the sharing policy for Paper doc.
paper_doc_deleted Void Paper doc archived. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_doc_delete_comment Void Deleted a Paper doc comment.
paper_doc_download Void Downloaded a Paper doc in a particular output format.
paper_doc_edit Void Edited a Paper doc.
paper_doc_edit_comment Void Edited a Paper doc comment.
paper_doc_followed Void Followed a Paper doc. This event is replaced by paper_content_change_subscription and will not be logged going forward.
paper_doc_mention Void Mentioned a member in a Paper doc.
paper_doc_request_access Void Requested to be a member on a Paper doc.
paper_doc_resolve_comment Void Paper doc comment resolved.
paper_doc_revert Void Restored a Paper doc to previous revision.
paper_doc_slack_share Void Paper doc link shared via slack.
paper_doc_team_invite Void Paper doc shared with team member. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_doc_unresolve_comment Void Unresolved a Paper doc comment.
paper_doc_view Void Viewed Paper doc.
paper_folder_deleted Void Paper folder archived. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
paper_folder_followed Void Followed a Paper folder. This event is replaced by paper_content_change_subscription and will not be logged going forward.
paper_folder_team_invite Void Paper folder shared with team member. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
password_change Void Changed password.
password_reset Void Reset password.
password_reset_all Void Reset all team member passwords.
emm_create_exceptions_report Void EMM excluded users report created.
emm_create_usage_report Void EMM mobile app usage report created.
smart_sync_create_admin_privilege_report Void Smart Sync non-admin devices report created.
team_activity_create_report Void Created a team activity report.
collection_share Void Shared an album.
file_add_comment Void Added a file comment.
file_like_comment Void Liked a file comment. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
file_unlike_comment Void Unliked a file comment. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_acl_invite_only Void Changed a Paper document to be invite-only. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_acl_link Void Changed a Paper document to be link accessible. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_acl_team_link Void Changed a Paper document to be link accessible for the team. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_shared Void Shared a Paper doc. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
note_share_receive Void Shared Paper document received. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
open_note_shared Void Opened a shared Paper doc. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_add_group Void Added the team to a shared folder.
sf_allow_non_members_to_view_shared_links Void Allowed non collaborators to view links to files in a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_invite_group Void Invited a group to a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_nest Void Changed parent of shared folder.
sf_team_decline Void Declined a team member's invitation to a shared folder.
sf_team_grant_access Void Granted access to a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_invite Void Invited team members to a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_invite_change_role Void Changed a team member's role in a shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_join Void Joined a team member's shared folder. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_join_from_oob_link Void Joined a team member's shared folder from a link. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sf_team_uninvite Void Unshared a folder with a team member. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
shared_content_add_invitees Void Sent an email invitation to the membership of a shared file or folder.
shared_content_add_link_expiry Void Added an expiry to the link for the shared file or folder.
shared_content_add_link_password Void Added a password to the link for the shared file or folder.
shared_content_add_member Void Added users and/or groups to the membership of a shared file or folder.
shared_content_change_downloads_policy Void Changed whether members can download the shared file or folder.
shared_content_change_invitee_role Void Changed the access type of an invitee to a shared file or folder before the invitation was claimed.
shared_content_change_link_audience Void Changed the audience of the link for a shared file or folder.
shared_content_change_link_expiry Void Changed the expiry of the link for the shared file or folder.
shared_content_change_link_password Void Changed the password on the link for the shared file or folder.
shared_content_change_member_role Void Changed the access type of a shared file or folder member.
shared_content_change_viewer_info_policy Void Changed whether members can see who viewed the shared file or folder.
shared_content_claim_invitation Void Claimed membership to a team member's shared folder.
shared_content_copy Void Copied the shared file or folder to own Dropbox.
shared_content_download Void Downloaded the shared file or folder.
shared_content_relinquish_membership Void Left the membership of a shared file or folder.
shared_content_remove_invitee Void Removed an invitee from the membership of a shared file or folder before it was claimed.
shared_content_remove_link_expiry Void Removed the expiry of the link for the shared file or folder.
shared_content_remove_link_password Void Removed the password on the link for the shared file or folder.
shared_content_remove_member Void Removed a user or a group from the membership of a shared file or folder.
shared_content_request_access Void Requested to be on the membership of a shared file or folder.
shared_content_unshare Void Unshared a shared file or folder by clearing its membership and turning off its link.
shared_content_view Void Previewed the shared file or folder.
shared_folder_change_confidentiality Void Set or unset the confidential flag on a shared folder.
shared_folder_change_link_policy Void Changed who can access the shared folder via a link.
shared_folder_change_member_management_policy Void Changed who can manage the membership of a shared folder.
shared_folder_change_member_policy Void Changed who can become a member of the shared folder.
shared_folder_create Void Created a shared folder.
shared_folder_mount Void Added a shared folder to own Dropbox.
shared_folder_transfer_ownership Void Transferred the ownership of a shared folder to another member.
shared_folder_unmount Void Deleted a shared folder from Dropbox.
shared_note_opened Void Shared Paper document was opened. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
shmodel_app_create Void Created a link to a file using an app.
shmodel_create Void Created a new link.
shmodel_disable Void Removed a link.
shmodel_fb_share Void Shared a link with Facebook users.
shmodel_group_share Void Shared a link with a group. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
shmodel_remove_expiration Void Removed the expiration date from a link.
shmodel_set_expiration Void Added an expiration date to a link.
shmodel_team_copy Void Added a team member's file/folder to their Dropbox from a link.
shmodel_team_download Void Downloaded a team member's file/folder from a link.
shmodel_team_share Void Shared a link with team members.
shmodel_team_view Void Opened a team member's link.
shmodel_visibility_password Void Password-protected a link.
shmodel_visibility_public Void Made a file/folder visible to anyone with the link.
shmodel_visibility_team_only Void Made a file/folder visible only to team members with the link.
remove_logout_url Void Removed single sign-on logout URL. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
remove_sso_url Void Changed the sign-out URL for SSO. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
sso_change_cert Void Changed the X.509 certificate for SSO.
sso_change_login_url Void Changed the sign-in URL for SSO.
sso_change_logout_url Void Changed the sign-out URL for SSO.
sso_change_saml_identity_mode Void Changed the SAML identity mode for SSO.
team_folder_change_status Void Changed the archival status of a team folder.
team_folder_create Void Created a new team folder in active status.
team_folder_downgrade Void Downgraded a team folder to a regular shared folder.
team_folder_permanently_delete Void Permanently deleted an archived team folder.
team_folder_rename Void Renamed an active or archived team folder.
account_capture_change_policy Void Changed the account capture policy on a domain belonging to the team.
allow_download_disabled Void Disabled allow downloads. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
allow_download_enabled Void Enabled allow downloads. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
data_placement_restriction_change_policy Void Set a restriction policy regarding the location of data centers where team data resides.
data_placement_restriction_satisfy_policy Void Satisfied a previously set restriction policy regarding the location of data centers where team data resides (i.e. all data have been migrated according to the restriction placed).
device_approvals_change_desktop_policy Void Set or removed a limit on the number of computers each team member can link to their work Dropbox account.
device_approvals_change_mobile_policy Void Set or removed a limit on the number of mobiles devices each team member can link to their work Dropbox account.
device_approvals_change_overage_action Void Changed the action taken when a team member is already over the limits (e.g when they join the team, an admin lowers limits, etc.).
device_approvals_change_unlink_action Void Changed the action taken with respect to approval limits when a team member unlinks an approved device.
emm_add_exception Void Added an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
emm_change_policy Void Enabled or disabled enterprise mobility management for team members.
emm_remove_exception Void Removed an exception for one or more team members to optionally use the regular Dropbox app when EMM is enabled.
extended_version_history_change_policy Void Accepted or opted out of extended version history.
file_comments_change_policy Void Enabled or disabled commenting on team files.
file_requests_change_policy Void Enabled or disabled file requests.
file_requests_emails_enabled Void Enabled file request emails for everyone. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
file_requests_emails_restricted_to_team_only Void Allowed file request emails for the team. This event is deprecated and will not be logged going forward as the associated product functionality no longer exists.
google_sso_change_policy Void Enabled or disabled Google single sign-on for the team.
group_user_management_change_policy Void Changed who can create groups.
member_requests_change_policy Void Changed whether users can find the team when not invited.
member_space_limits_add_exception Void Added an exception for one or more team members to bypass space limits imposed by policy.
member_space_limits_change_policy Void Changed the storage limits applied to team members by policy.
member_space_limits_remove_exception Void Removed an exception for one or more team members to bypass space limits imposed by policy.
member_suggestions_change_policy Void Enabled or disabled the option for team members to suggest new members to add to the team.
microsoft_office_addin_change_policy Void Enabled or disabled the Microsoft Office add-in, which lets team members save files to Dropbox directly from Microsoft Office.
network_control_change_policy Void Enabled or disabled network control.
paper_change_deployment_policy Void Changed whether Dropbox Paper, when enabled, is deployed to all teams or to specific members of the team.
paper_change_member_policy Void Changed whether team members can share Paper documents externally (i.e. outside the team), and if so, whether they should be accessible only by team members or anyone by default.
paper_change_policy Void Enabled or disabled Dropbox Paper for the team.
permanent_delete_change_policy Void Enabled or disabled the ability of team members to permanently delete content.
sharing_change_folder_join_policy Void Changed whether team members can join shared folders owned externally (i.e. outside the team).
sharing_change_link_policy Void Changed whether team members can share links externally (i.e. outside the team), and if so, whether links should be accessible only by team members or anyone by default.
sharing_change_member_policy Void Changed whether team members can share files and folders externally (i.e. outside the team).
smart_sync_change_policy Void Changed the default Smart Sync policy for team members.
smart_sync_not_opt_out Void Opted team into Smart Sync.
smart_sync_opt_out Void Opted team out of Smart Sync.
sso_change_policy Void Change the single sign-on policy for the team.
tfa_change_policy Void Change two-step verification policy for the team.
two_account_change_policy Void Enabled or disabled the option for team members to link a personal Dropbox account in addition to their work account to the same computer.
web_sessions_change_fixed_length_policy Void Changed how long team members can stay signed in to Dropbox on the web.
web_sessions_change_idle_length_policy Void Changed how long team members can be idle while signed in to Dropbox on the web.
team_profile_add_logo Void Added a team logo to be displayed on shared link headers.
team_profile_change_logo Void Changed the team logo to be displayed on shared link headers.
team_profile_change_name Void Changed the team name.
team_profile_remove_logo Void Removed the team logo to be displayed on shared link headers.
tfa_add_backup_phone Void Added a backup phone for two-step verification.
tfa_add_security_key Void Added a security key for two-step verification.
tfa_change_backup_phone Void Changed the backup phone for two-step verification.
tfa_change_status Void Enabled, disabled or changed the configuration for two-step verification.
tfa_remove_backup_phone Void Removed the backup phone for two-step verification.
tfa_remove_security_key Void Removed a security key for two-step verification.
tfa_reset Void Reset two-step verification for team member.
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.
member_change_membership_type_details MemberChangeMembershipTypeDetails Changed the membership type (limited vs full) for team member.
MemberChangeMembershipTypeDetails
Changed the membership type (limited vs full) for team 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.
full Void
free 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.
full Void
free Void
member_permanently_delete_account_contents_details MemberPermanentlyDeleteAccountContentsDetails Permanently deleted contents of a removed team member account.
MemberPermanentlyDeleteAccountContentsDetails
Permanently deleted contents of a removed team member account.
member_space_limits_change_status_details MemberSpaceLimitsChangeStatusDetails Changed the status with respect to whether the team member is under or over storage quota specified by policy.
MemberSpaceLimitsChangeStatusDetails
Changed the status with respect to whether the team member is under or over storage quota specified by policy.
previous_value SpaceLimitsStatus Previous storage quota status.
SpaceLimitsStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
within_quota Void
near_quota Void
over_quota Void
new_value SpaceLimitsStatus New storage quota status.
SpaceLimitsStatus (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
within_quota Void
near_quota Void
over_quota Void
member_transfer_account_contents_details MemberTransferAccountContentsDetails Transferred contents of a removed team member account to another member.
MemberTransferAccountContentsDetails
Transferred contents of a removed team member account to another member.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
paper_enabled_users_group_addition_details PaperEnabledUsersGroupAdditionDetails Users added to Paper enabled users list.
PaperEnabledUsersGroupAdditionDetails
Users added to Paper enabled users list.
paper_enabled_users_group_removal_details PaperEnabledUsersGroupRemovalDetails Users removed from Paper enabled users list.
PaperEnabledUsersGroupRemovalDetails
Users removed from Paper enabled users list.
paper_external_view_allow_details PaperExternalViewAllowDetails Paper external sharing policy changed: anyone.
PaperExternalViewAllowDetails
Paper external sharing policy changed: anyone.
paper_external_view_default_team_details PaperExternalViewDefaultTeamDetails Paper external sharing policy changed: default team.
PaperExternalViewDefaultTeamDetails
Paper external sharing policy changed: default team.
paper_external_view_forbid_details PaperExternalViewForbidDetails Paper external sharing policy changed: team-only.
PaperExternalViewForbidDetails
Paper external sharing policy changed: team-only.
sf_external_invite_warn_details SfExternalInviteWarnDetails Admin settings: team members see a warning before sharing folders outside the team (DEPRECATED FEATURE).
SfExternalInviteWarnDetails
Admin settings: team members see a warning before sharing folders outside the team (DEPRECATED FEATURE).
team_merge_details TeamMergeDetails Merged the team into another team.
TeamMergeDetails
Merged the team into another team.
merged_from_team_name String? Merged from team name. Might be missing due to historical data gap. This field is optional.
merged_to_team_name String? Merged to team name. Might be missing due to historical data gap. This field is optional.
app_link_team_details AppLinkTeamDetails Linked an app for team.
AppLinkTeamDetails
Linked an 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 Linked an app for team member.
AppLinkUserDetails
Linked an app for team 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 Unlinked an app for team.
AppUnlinkTeamDetails
Unlinked an 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 Unlinked an app for team member.
AppUnlinkUserDetails
Unlinked an app for team 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.
device_change_ip_desktop_details DeviceChangeIpDesktopDetails IP address associated with active desktop session changed.
DeviceChangeIpDesktopDetails
IP address associated with active desktop session changed.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_change_ip_mobile_details DeviceChangeIpMobileDetails IP address associated with active mobile session changed.
DeviceChangeIpMobileDetails
IP address associated with active mobile session changed.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_change_ip_web_details DeviceChangeIpWebDetails IP address associated with active Web session changed.
DeviceChangeIpWebDetails
IP address associated with active Web session changed.
user_agent String Web browser name.
device_info DeviceLogInfo? Device information. Might be missing due to historical data gap. This field is optional.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_delete_on_unlink_fail_details DeviceDeleteOnUnlinkFailDetails Failed to delete all files from an unlinked device.
DeviceDeleteOnUnlinkFailDetails
Failed to delete all files from an unlinked device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
num_failures Int64 The number of times that remote file deletion failed.
device_delete_on_unlink_success_details DeviceDeleteOnUnlinkSuccessDetails Deleted all files from an unlinked device.
DeviceDeleteOnUnlinkSuccessDetails
Deleted all files from an unlinked device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_link_fail_details DeviceLinkFailDetails Failed to link a device.
DeviceLinkFailDetails
Failed to link a 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.
mobile Void
desktop Void
device_info DeviceLogInfo? Device information. Might be missing due to historical data gap. This field is optional.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
device_link_success_details DeviceLinkSuccessDetails Linked a device.
DeviceLinkSuccessDetails
Linked a device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
app_version String? Linking app version. Might be missing due to historical data gap. This field is optional.
device_management_disabled_details DeviceManagementDisabledDetails Disable Device Management.
DeviceManagementDisabledDetails
Disable Device Management.
device_management_enabled_details DeviceManagementEnabledDetails Enable Device Management.
DeviceManagementEnabledDetails
Enable Device Management.
device_unlink_details DeviceUnlinkDetails Disconnected a device.
DeviceUnlinkDetails
Disconnected a device.
device_info DeviceLogInfo Device information.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
delete_data Boolean True if the user requested to delete data after device unlink, false otherwise.
emm_refresh_auth_token_details EmmRefreshAuthTokenDetails Refreshed the auth token used for setting up enterprise mobility management.
EmmRefreshAuthTokenDetails
Refreshed the auth token used for setting up enterprise mobility management.
account_capture_change_availability_details AccountCaptureChangeAvailabilityDetails Granted or revoked the option to enable account capture on domains belonging to the team.
AccountCaptureChangeAvailabilityDetails
Granted or revoked the option to enable account capture on domains belonging to the team.
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 Account captured user migrated their account to the team.
AccountCaptureMigrateAccountDetails
Account captured user migrated their account to the team.
domain_name String Domain name.
account_capture_relinquish_account_details AccountCaptureRelinquishAccountDetails Account captured user relinquished their account by changing the email address associated with it.
AccountCaptureRelinquishAccountDetails
Account captured user relinquished their account by changing the email address associated with it.
domain_name String Domain name.
disabled_domain_invites_details DisabledDomainInvitesDetails Disabled domain invites.
DisabledDomainInvitesDetails
Disabled domain invites.
domain_invites_approve_request_to_join_team_details DomainInvitesApproveRequestToJoinTeamDetails Approved a member's request to join the team.
DomainInvitesApproveRequestToJoinTeamDetails
Approved a member's request to join the team.
domain_invites_decline_request_to_join_team_details DomainInvitesDeclineRequestToJoinTeamDetails Declined a user's request to join the team.
DomainInvitesDeclineRequestToJoinTeamDetails
Declined a user's request to join the team.
domain_invites_email_existing_users_details DomainInvitesEmailExistingUsersDetails Sent domain invites to existing domain accounts.
DomainInvitesEmailExistingUsersDetails
Sent domain invites to existing domain accounts.
domain_name List of (String) Domain names.
num_recipients UInt64 Number of recipients.
domain_invites_request_to_join_team_details DomainInvitesRequestToJoinTeamDetails Asked to join the team.
DomainInvitesRequestToJoinTeamDetails
Asked to join the team.
domain_invites_set_invite_new_user_pref_to_no_details DomainInvitesSetInviteNewUserPrefToNoDetails Turned off u201cAutomatically invite new usersu201d.
DomainInvitesSetInviteNewUserPrefToNoDetails
Turned off u201cAutomatically invite new usersu201d.
domain_invites_set_invite_new_user_pref_to_yes_details DomainInvitesSetInviteNewUserPrefToYesDetails Turned on u201cAutomatically invite new usersu201d.
DomainInvitesSetInviteNewUserPrefToYesDetails
Turned on u201cAutomatically invite new usersu201d.
domain_verification_add_domain_fail_details DomainVerificationAddDomainFailDetails Failed to verify a domain belonging to the team.
DomainVerificationAddDomainFailDetails
Failed to verify a domain belonging to the team.
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 Verified a domain belonging to the team.
DomainVerificationAddDomainSuccessDetails
Verified a domain belonging to the team.
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 Removed a domain from the list of verified domains belonging to the team.
DomainVerificationRemoveDomainDetails
Removed a domain from the list of verified domains belonging to the team.
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.
enabled_domain_invites_details EnabledDomainInvitesDetails Enabled domain invites.
EnabledDomainInvitesDetails
Enabled domain invites.
create_folder_details CreateFolderDetails Created folders.
CreateFolderDetails
Created folders.
file_add_details FileAddDetails Added files and/or folders.
FileAddDetails
Added files and/or folders.
file_copy_details FileCopyDetails Copied files and/or folders.
FileCopyDetails
Copied files and/or folders.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_delete_details FileDeleteDetails Deleted files and/or folders.
FileDeleteDetails
Deleted files and/or folders.
file_download_details FileDownloadDetails Downloaded files and/or folders.
FileDownloadDetails
Downloaded files and/or folders.
file_edit_details FileEditDetails Edited files.
FileEditDetails
Edited files.
file_get_copy_reference_details FileGetCopyReferenceDetails Create a copy reference to a file or folder.
FileGetCopyReferenceDetails
Create a copy reference to a file or folder.
file_move_details FileMoveDetails Moved files and/or folders.
FileMoveDetails
Moved files and/or folders.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_permanently_delete_details FilePermanentlyDeleteDetails Permanently deleted files and/or folders.
FilePermanentlyDeleteDetails
Permanently deleted files and/or folders.
file_preview_details FilePreviewDetails Previewed files and/or folders.
FilePreviewDetails
Previewed files and/or folders.
file_rename_details FileRenameDetails Renamed files and/or folders.
FileRenameDetails
Renamed files and/or folders.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_restore_details FileRestoreDetails Restored deleted files and/or folders.
FileRestoreDetails
Restored deleted files and/or folders.
file_revert_details FileRevertDetails Reverted files to a previous version.
FileRevertDetails
Reverted files to a previous version.
file_rollback_changes_details FileRollbackChangesDetails Rolled back file change location changes.
FileRollbackChangesDetails
Rolled back file change location changes.
file_save_copy_reference_details FileSaveCopyReferenceDetails Save a file or folder using a copy reference.
FileSaveCopyReferenceDetails
Save a file or folder using a copy reference.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
file_request_add_deadline_details FileRequestAddDeadlineDetails Added a deadline to a file request.
FileRequestAddDeadlineDetails
Added a deadline to a file request.
request_title String File request title.
file_request_change_folder_details FileRequestChangeFolderDetails Changed the file request folder.
FileRequestChangeFolderDetails
Changed the file request folder.
request_title String File request title.
file_request_change_title_details FileRequestChangeTitleDetails Change the file request title.
FileRequestChangeTitleDetails
Change the file request title.
request_title String File request title.
file_request_close_details FileRequestCloseDetails Closed a file request.
FileRequestCloseDetails
Closed a file request.
request_title String File request title.
file_request_create_details FileRequestCreateDetails Created a file request.
FileRequestCreateDetails
Created a file request.
request_title String File request title.
file_request_receive_file_details FileRequestReceiveFileDetails Received files for a file request.
FileRequestReceiveFileDetails
Received files for a file request.
request_title String File request title.
submitted_file_names List of (String) Submitted file names.
file_request_remove_deadline_details FileRequestRemoveDeadlineDetails Removed the file request deadline.
FileRequestRemoveDeadlineDetails
Removed the file request deadline.
request_title String File request title.
file_request_send_details FileRequestSendDetails Sent file request to users via email.
FileRequestSendDetails
Sent file request to users via email.
request_title String File request title.
group_add_external_id_details GroupAddExternalIdDetails Added an external ID for group.
GroupAddExternalIdDetails
Added an external ID for group.
new_value String Current external id.
group_add_member_details GroupAddMemberDetails Added team members to a group.
GroupAddMemberDetails
Added team members to a group.
is_group_owner Boolean Is group owner.
group_change_external_id_details GroupChangeExternalIdDetails Changed the external ID for group.
GroupChangeExternalIdDetails
Changed the external ID for group.
new_value String Current external id.
previous_value String Old external id.
group_change_management_type_details GroupChangeManagementTypeDetails Changed group management type.
GroupChangeManagementTypeDetails
Changed group management type.
new_value GroupManagementType New group management type.
GroupManagementType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
admin_management_group Void
member_management_group Void
previous_value GroupManagementType? Previous group management type. Might be missing due to historical data gap. This field is optional.
GroupManagementType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
admin_management_group Void
member_management_group Void
group_change_member_role_details GroupChangeMemberRoleDetails Changed the manager permissions belonging to a group member.
GroupChangeMemberRoleDetails
Changed the manager permissions belonging to a group member.
is_group_owner Boolean Is group owner.
group_create_details GroupCreateDetails Created a group.
GroupCreateDetails
Created a group.
join_policy GroupJoinPolicy Group join policy.
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
is_admin_managed Boolean? Is admin managed group. Might be missing due to historical data gap. This field is optional.
group_delete_details GroupDeleteDetails Deleted a group.
GroupDeleteDetails
Deleted a group.
is_admin_managed Boolean? Is admin managed group. Might be missing due to historical data gap. This field is optional.
group_description_updated_details GroupDescriptionUpdatedDetails Updated a group.
GroupDescriptionUpdatedDetails
Updated a group.
group_join_policy_updated_details GroupJoinPolicyUpdatedDetails Updated a group join policy.
GroupJoinPolicyUpdatedDetails
Updated a group join policy.
join_policy GroupJoinPolicy Group join policy.
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
is_admin_managed Boolean? Is admin managed group. Might be missing due to historical data gap. This field is optional.
group_moved_details GroupMovedDetails Moved a group.
GroupMovedDetails
Moved a group.
group_remove_external_id_details GroupRemoveExternalIdDetails Removed the external ID for group.
GroupRemoveExternalIdDetails
Removed the external ID for group.
previous_value String Old external id.
group_remove_member_details GroupRemoveMemberDetails Removed team members from a group.
GroupRemoveMemberDetails
Removed team members from a group.
group_rename_details GroupRenameDetails Renamed a group.
GroupRenameDetails
Renamed a group.
previous_value String Previous display name.
emm_login_success_details EmmLoginSuccessDetails Signed in using the Dropbox EMM app.
EmmLoginSuccessDetails
Signed in using the Dropbox EMM app.
logout_details LogoutDetails Signed out.
LogoutDetails
Signed out.
password_login_fail_details PasswordLoginFailDetails Failed to sign in using a password.
PasswordLoginFailDetails
Failed to sign in using a password.
failure_reason String? Login failure reason. Might be missing due to historical data gap. This field is optional.
password_login_success_details PasswordLoginSuccessDetails Signed in using a password.
PasswordLoginSuccessDetails
Signed in using a password.
reseller_support_session_end_details ResellerSupportSessionEndDetails Ended reseller support session.
ResellerSupportSessionEndDetails
Ended reseller support session.
reseller_support_session_start_details ResellerSupportSessionStartDetails Started reseller support session.
ResellerSupportSessionStartDetails
Started reseller support session.
sign_in_as_session_end_details SignInAsSessionEndDetails Ended admin sign-in-as session.
SignInAsSessionEndDetails
Ended admin sign-in-as session.
sign_in_as_session_start_details SignInAsSessionStartDetails Started admin sign-in-as session.
SignInAsSessionStartDetails
Started admin sign-in-as session.
sso_login_fail_details SsoLoginFailDetails Failed to sign in using SSO.
SsoLoginFailDetails
Failed to sign in using SSO.
failure_reason String? Login failure reason. Might be missing due to historical data gap. This field is optional.
tech_reason String? Technical failure reason. This field is optional.
member_add_name_details MemberAddNameDetails Set team member name when joining team.
MemberAddNameDetails
Set team member name when joining team.
new_value UserNameLogInfo 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_email_details MemberChangeEmailDetails Changed team member email address.
MemberChangeEmailDetails
Changed team member email address.
new_value String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$") New email.
previous_value String(max_length=255, pattern="^['&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*.[A-Za-z]{2,15}$")? Previous email. Might be missing due to historical data gap. This field is optional.
member_change_name_details MemberChangeNameDetails Changed team member name.
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.
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_role_details MemberChangeRoleDetails Change the admin permissions belonging to team member.
MemberChangeRoleDetails
Change the admin permissions belonging to team member.
new_value String? New admin role. Might be missing due to historical data gap. This field is optional.
previous_value String? Previous admin role. Might be missing due to historical data gap. This field is optional.
member_change_status_details MemberChangeStatusDetails Changed the membership status of a team member.
MemberChangeStatusDetails
Changed the membership status of a team member.
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
team_join_details JoinTeamDetails? Additional information relevant when a new member joins the team. This field is optional.
JoinTeamDetails
Additional information relevant when a new member joins the team.
linked_apps List of (AppLogInfo) Linked applications.
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.
linked_devices List of (DeviceLogInfo) Linked devices.
DeviceLogInfo
Device's logged information.
device_id String? Device unique id. Might be missing due to historical data gap. This field is optional.
display_name String? Device display name. Might be missing due to historical data gap. This field is optional.
is_emm_managed Boolean? True if this device is emm managed, false otherwise. Might be missing due to historical data gap. This field is optional.
platform String? Device platform name. Might be missing due to historical data gap. This field is optional.
mac_address String? Device mac address. Might be missing due to historical data gap. This field is optional.
os_version String? Device OS version. Might be missing due to historical data gap. This field is optional.
device_type String? Device type. Might be missing due to historical data gap. This field is optional.
ip_address String(pattern="^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")? IP address. Might be missing due to historical data gap. This field is optional.
last_activity String? Last activity. Might be missing due to historical data gap. This field is optional.
linked_shared_folders List of (FolderLogInfo) Linked shared folders.
FolderLogInfo
Folder's logged information.
path PathLogInfo Path relative to event context.
PathLogInfo
Path's details.
namespace_relative NamespaceRelativePathLogInfo Path relative to the namespace containing the content.
NamespaceRelativePathLogInfo
Namespace relative path details.
ns_id String(pattern="[-_0-9a-zA-Z:]+")? Namespace ID. Might be missing due to historical data gap. This field is optional.
relative_path String(pattern="/(.|[\r\n])*")? A path relative to the specified namespace ID. Might be missing due to historical data gap. This field is optional.
contextual String(pattern="/(.|[\r\n])*")? Fully qualified path relative to event's context. Might be missing due to historical data gap. This field is optional.
display_name String? Display name. Might be missing due to historical data gap. This field is optional.
file_id String? Unique ID. Might be missing due to historical data gap. This field is optional.
member_suggest_details MemberSuggestDetails Suggested a new team member to be added to the team.
MemberSuggestDetails
Suggested a new team member to be added to the team.
paper_content_add_member_details PaperContentAddMemberDetails Added users to the membership of a Paper doc or folder.
PaperContentAddMemberDetails
Added users to the membership of a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_add_to_folder_details PaperContentAddToFolderDetails Added Paper doc or folder to a folder.
PaperContentAddToFolderDetails
Added Paper doc or folder to a folder.
event_uuid String Event unique identifier.
target_index Int64 Target asset index.
parent_index Int64 Parent asset index.
paper_content_archive_details PaperContentArchiveDetails Archived Paper doc or folder.
PaperContentArchiveDetails
Archived Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_change_subscription_details PaperContentChangeSubscriptionDetails Followed or unfollowed a Paper doc or folder.
PaperContentChangeSubscriptionDetails
Followed or unfollowed a Paper doc or folder.
event_uuid String Event unique identifier.
new_subscription_level PaperTaggedValue New subscription level.
PaperTaggedValue
Paper tagged value.
tag String Tag.
previous_subscription_level PaperTaggedValue? Previous subscription level. Might be missing due to historical data gap. This field is optional.
PaperTaggedValue
Paper tagged value.
tag String Tag.
paper_content_create_details PaperContentCreateDetails Created a Paper doc or folder.
PaperContentCreateDetails
Created a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_permanently_delete_details PaperContentPermanentlyDeleteDetails Permanently deleted a Paper doc or folder.
PaperContentPermanentlyDeleteDetails
Permanently deleted a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_remove_from_folder_details PaperContentRemoveFromFolderDetails Removed Paper doc or folder from a folder.
PaperContentRemoveFromFolderDetails
Removed Paper doc or folder from a folder.
event_uuid String Event unique identifier.
paper_content_remove_member_details PaperContentRemoveMemberDetails Removed a user from the membership of a Paper doc or folder.
PaperContentRemoveMemberDetails
Removed a user from the membership of a Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_rename_details PaperContentRenameDetails Renamed Paper doc or folder.
PaperContentRenameDetails
Renamed Paper doc or folder.
event_uuid String Event unique identifier.
paper_content_restore_details PaperContentRestoreDetails Restored an archived Paper doc or folder.
PaperContentRestoreDetails
Restored an archived Paper doc or folder.
event_uuid String Event unique identifier.
paper_doc_add_comment_details PaperDocAddCommentDetails Added a Paper doc comment.
PaperDocAddCommentDetails
Added a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_change_member_role_details PaperDocChangeMemberRoleDetails Changed the access type of a Paper doc member.
PaperDocChangeMemberRoleDetails
Changed the access type of a Paper doc member.
event_uuid String Event unique identifier.
access_type PaperAccessType Paper doc access type.
PaperAccessType (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
viewer Void
commenter Void
editor Void
paper_doc_change_sharing_policy_details PaperDocChangeSharingPolicyDetails Changed the sharing policy for Paper doc.
PaperDocChangeSharingPolicyDetails
Changed the sharing policy for Paper doc.
event_uuid String Event unique identifier.
public_sharing_policy String? Sharing policy with external users. Might be missing due to historical data gap. This field is optional.
team_sharing_policy String? Sharing policy with team. Might be missing due to historical data gap. This field is optional.
paper_doc_deleted_details PaperDocDeletedDetails Paper doc archived.
PaperDocDeletedDetails
Paper doc archived.
event_uuid String Event unique identifier.
paper_doc_delete_comment_details PaperDocDeleteCommentDetails Deleted a Paper doc comment.
PaperDocDeleteCommentDetails
Deleted a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_download_details PaperDocDownloadDetails Downloaded a Paper doc in a particular output format.
PaperDocDownloadDetails
Downloaded a Paper doc in a particular output format.
event_uuid String Event unique identifier.
export_file_format PaperDownloadFormat Export file format.
PaperDownloadFormat (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
docx Void
html Void
markdown Void
paper_doc_edit_details PaperDocEditDetails Edited a Paper doc.
PaperDocEditDetails
Edited a Paper doc.
event_uuid String Event unique identifier.
paper_doc_edit_comment_details PaperDocEditCommentDetails Edited a Paper doc comment.
PaperDocEditCommentDetails
Edited a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_followed_details PaperDocFollowedDetails Followed a Paper doc.
PaperDocFollowedDetails
Followed a Paper doc.
event_uuid String Event unique identifier.
paper_doc_mention_details PaperDocMentionDetails Mentioned a member in a Paper doc.
PaperDocMentionDetails
Mentioned a member in a Paper doc.
event_uuid String Event unique identifier.
paper_doc_request_access_details PaperDocRequestAccessDetails Requested to be a member on a Paper doc.
PaperDocRequestAccessDetails
Requested to be a member on a Paper doc.
event_uuid String Event unique identifier.
paper_doc_resolve_comment_details PaperDocResolveCommentDetails Paper doc comment resolved.
PaperDocResolveCommentDetails
Paper doc comment resolved.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_revert_details PaperDocRevertDetails Restored a Paper doc to previous revision.
PaperDocRevertDetails
Restored a Paper doc to previous revision.
event_uuid String Event unique identifier.
paper_doc_slack_share_details PaperDocSlackShareDetails Paper doc link shared via slack.
PaperDocSlackShareDetails
Paper doc link shared via slack.
event_uuid String Event unique identifier.
paper_doc_team_invite_details PaperDocTeamInviteDetails Paper doc shared with team member.
PaperDocTeamInviteDetails
Paper doc shared with team member.
event_uuid String Event unique identifier.
paper_doc_unresolve_comment_details PaperDocUnresolveCommentDetails Unresolved a Paper doc comment.
PaperDocUnresolveCommentDetails
Unresolved a Paper doc comment.
event_uuid String Event unique identifier.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
paper_doc_view_details PaperDocViewDetails Viewed Paper doc.
PaperDocViewDetails
Viewed Paper doc.
event_uuid String Event unique identifier.
paper_folder_deleted_details PaperFolderDeletedDetails Paper folder archived.
PaperFolderDeletedDetails
Paper folder archived.
event_uuid String Event unique identifier.
paper_folder_followed_details PaperFolderFollowedDetails Followed a Paper folder.
PaperFolderFollowedDetails
Followed a Paper folder.
event_uuid String Event unique identifier.
paper_folder_team_invite_details PaperFolderTeamInviteDetails Paper folder shared with team member.
PaperFolderTeamInviteDetails
Paper folder shared with team member.
event_uuid String Event unique identifier.
password_change_details PasswordChangeDetails Changed password.
PasswordChangeDetails
Changed password.
password_reset_details PasswordResetDetails Reset password.
PasswordResetDetails
Reset password.
password_reset_all_details PasswordResetAllDetails Reset all team member passwords.
PasswordResetAllDetails
Reset all team member passwords.
emm_create_exceptions_report_details EmmCreateExceptionsReportDetails EMM excluded users report created.
EmmCreateExceptionsReportDetails
EMM excluded users report created.
emm_create_usage_report_details EmmCreateUsageReportDetails EMM mobile app usage report created.
EmmCreateUsageReportDetails
EMM mobile app usage report created.
smart_sync_create_admin_privilege_report_details SmartSyncCreateAdminPrivilegeReportDetails Smart Sync non-admin devices report created.
SmartSyncCreateAdminPrivilegeReportDetails
Smart Sync non-admin devices report created.
team_activity_create_report_details TeamActivityCreateReportDetails Created a team activity report.
TeamActivityCreateReportDetails
Created a team activity report.
start_date Timestamp(format="%Y-%m-%d") Report start date.
end_date Timestamp(format="%Y-%m-%d") Report end date.
collection_share_details CollectionShareDetails Shared an album.
CollectionShareDetails
Shared an album.
album_name String Album name.
file_add_comment_details FileAddCommentDetails Added a file comment.
FileAddCommentDetails
Added a file comment.
target_index Int64 Target asset index.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_like_comment_details FileLikeCommentDetails Liked a file comment.
FileLikeCommentDetails
Liked a file comment.
target_index Int64 Target asset index.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
file_unlike_comment_details FileUnlikeCommentDetails Unliked a file comment.
FileUnlikeCommentDetails
Unliked a file comment.
target_index Int64 Target asset index.
comment_text String? Comment text. Might be missing due to historical data gap. This field is optional.
note_acl_invite_only_details NoteAclInviteOnlyDetails Changed a Paper document to be invite-only.
NoteAclInviteOnlyDetails
Changed a Paper document to be invite-only.
note_acl_link_details NoteAclLinkDetails Changed a Paper document to be link accessible.
NoteAclLinkDetails
Changed a Paper document to be link accessible.
note_acl_team_link_details NoteAclTeamLinkDetails Changed a Paper document to be link accessible for the team.
NoteAclTeamLinkDetails
Changed a Paper document to be link accessible for the team.
note_shared_details NoteSharedDetails Shared a Paper doc.
NoteSharedDetails
Shared a Paper doc.
note_share_receive_details NoteShareReceiveDetails Shared Paper document received.
NoteShareReceiveDetails
Shared Paper document received.
open_note_shared_details OpenNoteSharedDetails Opened a shared Paper doc.
OpenNoteSharedDetails
Opened a shared Paper doc.
sf_add_group_details SfAddGroupDetails Added the team to a shared folder.
SfAddGroupDetails
Added the team to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
team_name String Team name.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
sf_allow_non_members_to_view_shared_links_details SfAllowNonMembersToViewSharedLinksDetails Allowed non collaborators to view links to files in a shared folder.
SfAllowNonMembersToViewSharedLinksDetails
Allowed non collaborators to view links to files in a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
sf_invite_group_details SfInviteGroupDetails Invited a group to a shared folder.
SfInviteGroupDetails
Invited a group to a shared folder.
target_index Int64 Target asset index.
sf_nest_details SfNestDetails Changed parent of shared folder.
SfNestDetails
Changed parent of shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
prev_parent_ns_id String(pattern="[-_0-9a-zA-Z:]+")? Previous parent namespace ID. Might be missing due to historical data gap. This field is optional.
new_parent_ns_id String(pattern="[-_0-9a-zA-Z:]+")? New parent namespace ID. Might be missing due to historical data gap. This field is optional.
sf_team_decline_details SfTeamDeclineDetails Declined a team member's invitation to a shared folder.
SfTeamDeclineDetails
Declined a team member's invitation to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sf_team_grant_access_details SfTeamGrantAccessDetails Granted access to a shared folder.
SfTeamGrantAccessDetails
Granted access to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sf_team_invite_details SfTeamInviteDetails Invited team members to a shared folder.
SfTeamInviteDetails
Invited team members to a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
sf_team_invite_change_role_details SfTeamInviteChangeRoleDetails Changed a team member's role in a shared folder.
SfTeamInviteChangeRoleDetails
Changed a team member's role in a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
previous_sharing_permission String? Previous sharing permission. Might be missing due to historical data gap. This field is optional.
sf_team_join_details SfTeamJoinDetails Joined a team member's shared folder.
SfTeamJoinDetails
Joined a team member's shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
sf_team_join_from_oob_link_details SfTeamJoinFromOobLinkDetails Joined a team member's shared folder from a link.
SfTeamJoinFromOobLinkDetails
Joined a team member's shared folder from a link.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
token_key String? Shared link token key. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
sf_team_uninvite_details SfTeamUninviteDetails Unshared a folder with a team member.
SfTeamUninviteDetails
Unshared a folder with a team member.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_content_add_invitees_details SharedContentAddInviteesDetails Sent an email invitation to the membership of a shared file or folder.
SharedContentAddInviteesDetails
Sent an email invitation to the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_add_link_expiry_details SharedContentAddLinkExpiryDetails Added an expiry to the link for the shared file or folder.
SharedContentAddLinkExpiryDetails
Added an expiry to the link for the shared file or folder.
target_index Int64 Target asset index.
expiration_start_date String Expiration starting date.
expiration_days Int64 The number of days from the starting expiration date after which the link will expire.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_add_link_password_details SharedContentAddLinkPasswordDetails Added a password to the link for the shared file or folder.
SharedContentAddLinkPasswordDetails
Added a password to the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_add_member_details SharedContentAddMemberDetails Added users and/or groups to the membership of a shared file or folder.
SharedContentAddMemberDetails
Added users and/or groups to the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_change_downloads_policy_details SharedContentChangeDownloadsPolicyDetails Changed whether members can download the shared file or folder.
SharedContentChangeDownloadsPolicyDetails
Changed whether members can download the shared file or folder.
target_index Int64 Target asset index.
new_value SharedContentDownloadsPolicy New downlaod policy.
SharedContentDownloadsPolicy (open union)
Shared content downloads policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedContentDownloadsPolicy? Previous downlaod policy. Might be missing due to historical data gap. This field is optional.
SharedContentDownloadsPolicy (open union)
Shared content downloads policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
shared_content_change_invitee_role_details SharedContentChangeInviteeRoleDetails Changed the access type of an invitee to a shared file or folder before the invitation was claimed.
SharedContentChangeInviteeRoleDetails
Changed the access type of an invitee to a shared file or folder before the invitation was claimed.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
previous_sharing_permission String? Previous sharing permission. Might be missing due to historical data gap. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_change_link_audience_details SharedContentChangeLinkAudienceDetails Changed the audience of the link for a shared file or folder.
SharedContentChangeLinkAudienceDetails
Changed the audience of the link for a shared file or folder.
target_index Int64 Target asset index.
new_value LinkAudience New link audience value.
LinkAudience (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
public Void
team Void
members Void
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value LinkAudience? Previous link audience value. Might be missing due to historical data gap. This field is optional.
LinkAudience (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
public Void
team Void
members Void
shared_content_change_link_expiry_details SharedContentChangeLinkExpiryDetails Changed the expiry of the link for the shared file or folder.
SharedContentChangeLinkExpiryDetails
Changed the expiry of the link for the shared file or folder.
target_index Int64 Target asset index.
expiration_start_date String Expiration starting date.
expiration_days Int64 The number of days from the starting expiration date after which the link will expire.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_change_link_password_details SharedContentChangeLinkPasswordDetails Changed the password on the link for the shared file or folder.
SharedContentChangeLinkPasswordDetails
Changed the password on the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_change_member_role_details SharedContentChangeMemberRoleDetails Changed the access type of a shared file or folder member.
SharedContentChangeMemberRoleDetails
Changed the access type of a shared file or folder member.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_sharing_permission String? Previous sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_change_viewer_info_policy_details SharedContentChangeViewerInfoPolicyDetails Changed whether members can see who viewed the shared file or folder.
SharedContentChangeViewerInfoPolicyDetails
Changed whether members can see who viewed the shared file or folder.
target_index Int64 Target asset index.
new_value SharedContentViewerInfoPolicy New viewer info policy.
SharedContentViewerInfoPolicy (open union)
Shared content viewer info policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
previous_value SharedContentViewerInfoPolicy? Previous view info policy. Might be missing due to historical data gap. This field is optional.
SharedContentViewerInfoPolicy (open union)
Shared content viewer info policy The value will be one of the following datatypes. New values may be introduced as our API evolves.
disabled Void
enabled Void
shared_content_claim_invitation_details SharedContentClaimInvitationDetails Claimed membership to a team member's shared folder.
SharedContentClaimInvitationDetails
Claimed membership to a team member's shared folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_content_link String? Shared content link. This field is optional.
shared_content_copy_details SharedContentCopyDetails Copied the shared file or folder to own Dropbox.
SharedContentCopyDetails
Copied the shared file or folder to own Dropbox.
shared_content_link String Shared content link.
src_index Int64 Source asset index.
dest_index Int64 Destination asset index.
target_index Int64 Target asset index.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_download_details SharedContentDownloadDetails Downloaded the shared file or folder.
SharedContentDownloadDetails
Downloaded the shared file or folder.
shared_content_link String Shared content link.
target_index Int64 Target asset index.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_content_relinquish_membership_details SharedContentRelinquishMembershipDetails Left the membership of a shared file or folder.
SharedContentRelinquishMembershipDetails
Left the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_content_remove_invitee_details SharedContentRemoveInviteeDetails Removed an invitee from the membership of a shared file or folder before it was claimed.
SharedContentRemoveInviteeDetails
Removed an invitee from the membership of a shared file or folder before it was claimed.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
shared_content_remove_link_expiry_details SharedContentRemoveLinkExpiryDetails Removed the expiry of the link for the shared file or folder.
SharedContentRemoveLinkExpiryDetails
Removed the expiry of the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_remove_link_password_details SharedContentRemoveLinkPasswordDetails Removed the password on the link for the shared file or folder.
SharedContentRemoveLinkPasswordDetails
Removed the password on the link for the shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_remove_member_details SharedContentRemoveMemberDetails Removed a user or a group from the membership of a shared file or folder.
SharedContentRemoveMemberDetails
Removed a user or a group from the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_type String? Shared folder type. Might be missing due to historical data gap. This field is optional.
shared_content_request_access_details SharedContentRequestAccessDetails Requested to be on the membership of a shared file or folder.
SharedContentRequestAccessDetails
Requested to be on the membership of a shared file or folder.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_content_link String? Shared content link. This field is optional.
shared_content_unshare_details SharedContentUnshareDetails Unshared a shared file or folder by clearing its membership and turning off its link.
SharedContentUnshareDetails
Unshared a shared file or folder by clearing its membership and turning off its link.
target_index Int64 Target asset index.
original_folder_name String? Original shared folder name. This field is optional.
shared_content_view_details SharedContentViewDetails Previewed the shared file or folder.
SharedContentViewDetails
Previewed the shared file or folder.
shared_content_link String Shared content link.
target_index Int64 Target asset index.
sharing_permission String? Sharing permission. Might be missing due to historical data gap. This field is optional.
shared_folder_change_confidentiality_details SharedFolderChangeConfidentialityDetails Set or unset the confidential flag on a shared folder.
SharedFolderChangeConfidentialityDetails
Set or unset the confidential flag on a shared folder.
target_index Int64 Target asset index.
original_folder_name String Original shared folder name.
new_value Confidentiality New confidentiality value.
Confidentiality (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
confidential Void
non_confidential Void
previous_value Confidentiality? Previous confidentiality value. Might be missing due to historical data gap. This field is optional.
Confidentiality (open union)
The value will be one of the following datatypes. New values may be introduced as our API evolves.
confidential Void
non_confidential Void
shared_folder_change_link_policy_details SharedFolderChangeLinkPolicyDetails Changed who can access the shared fo