Warning: API v1 has been deprecated. Learn more.

Dropbox Business API Documentation

Each Dropbox Business API request should be made as a POST request with an "application/json" Content-Type header. Parameters should be passed in the body in a JSON dictionary (not form-encoded). Requests with no parameters should pass an empty JSON dictionary ({}).

These JSON formatting conventions apply only to Dropbox Business API endpoints. All "X-Dropbox-Perform-As-Team-Member" calls are made using the Core API, and should continue to be form-encoded as specified in the Core API documentation.

The Dropbox Business API uses the following HTTP status codes for errors:

  • 400: Bad input parameter. Error message should indicate which one and why.
  • 401: Bad or expired token. This can happen if the user or Dropbox revoked or expired an access token. To fix, you should re-authenticate the user.
  • 403: Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
  • 409: The request is well-formed but cannot be completed. The error message should indicate why.

Team info

/get_info

Description
Retrieves information about a team.
URL structure
https://api.dropbox.com/1/team/get_info
Method
POST
Permission
Team information
Parameters
None
Returns

Information about a team.

Sample response body

{
  "name": "Example Company",
  "team_id": "dbtid:1234abcd",
  "num_licensed_users": 5,
  "num_provisioned_users": 2
}

Notes
  • team_id is a globally-unique team identifier.
  • num_licensed_users is the total number of licenses the team has authorized, while num_provisioned_users is the number of accounts that have been invited or are already active members of the team.

Member info

/members/list

Description
Lists members of a team.
URL structure
https://api.dropbox.com/1/team/members/list
Method
POST
Permission
Team information
Parameters
limit
optional number of results to return per call (default 1000, maximum 1000)
cursor
optional encoded value indicating from what point to get the next limit members

Sample request body

{
  "limit": 10,
  "cursor": "abcd1234"
}

Returns

A list of team members.

Sample response body

{
  "members": [
    {
      "profile": {
        "given_name": "Jane",
        "surname": "User",
        "status": "active",
        "member_id": "dbmid:abcd1234",
        "email": "jane@example.com",
        "email_verified": true,
        "external_id": "54321",
        "groups": []
      },
      "permissions": {
        "is_admin": true
      }
    },
    ...
    "cursor": "abcd1234",
    "has_more": false
  ]
}

/members/get_info

Description
Retrieves information about a team member.
URL structure
https://api.dropbox.com/1/team/members/get_info
Method
POST
Permission
Team information
Parameters
member_id
optional ID of member
email
optional email of member
external_id
optional external ID of member

Exactly one of member_id, email, and external_id must be set.

Sample request body

{
  "member_id": "dbmid:efgh5678"
}

Returns

Information about a team member.

Sample response body

{
  "profile": {
    "given_name": "John",
    "surname": "User",
    "status": "active",
    "member_id": "dbmid:efgh5678",
    "email": "john@example.com",
    "email_verified": true,
    "external_id": "09876",
    "groups": []
  },
  "permissions": {
    "is_admin": false
  }
}

Errors
400
Invalid parameters. This endpoint must include exactly one parameter.
409
No matching member found. The user does not exist on this team.
Notes
  • The external_id parameter will only be returned to apps with Team member management permissions. This value will be null if not set.

/members/get_info_batch

Description
Retrieves information about multiple team members.
URL structure
https://api.dropbox.com/1/team/members/get_info_batch
Method
POST
Permission
Team information
Parameters
member_ids
optional list of member IDs
emails
optional list of member emails
external_ids
optional list of external member IDs

Exactly one of member_id, email, and external_id must be set.

Sample request body

{
  "emails": ["jane@example.com", "john@example.com"]
}

Returns

Information about multiple team members.

Sample response body

{
  "jane@example.com": {
    "profile": {
      "given_name": "Jane",
      "surname": "User",
      "status": "active",
      "member_id": "dbmid:abcd1234",
      "email": "jane@example.com",
      "email_verified": true,
      "external_id": "54321",
      "groups": []
    },
    "permissions": {
      "is_admin": true
    }
  },
  "john@example.com": {
    "profile": {
      "given_name": "John",
      "surname": "User",
      "status": "active",
      "member_id": "dbmid:efgh5678",
      "email": "john@example.com",
      "email_verified": true,
      "external_id": "09876",
      "groups": []
    },
    "permissions": {
      "is_admin": false
    }
  }
}

Errors
400
Invalid parameters. This endpoint must include exactly one parameter.
Notes
  • All references within a given call must use the same type of identifier (i.e. if you want to look up two members by email and five by member_id, you'll need to make two separate calls).
  • This endpoint will return a null value for entries that cannot be matched to a valid team member.

Member management

/members/add

Description
Adds a member to a team.
URL structure
https://api.dropbox.com/1/team/members/add
Method
POST
Permission
Team member management
Parameters
member_email
member email
member_given_name
member first name
member_surname
member last name
member_external_id
optional external ID for member
send_welcome_email
optional boolean to send a welcome email to the member. Default is true.

Sample request body

{
  "member_email": "jenny@example.com",
  "member_given_name": "Jenny",
  "member_surname": "User",
  "send_welcome_email": true
}

Returns

Returns the profile of the created member. See /members/get_info for a sample response.

Errors
409
Team is already full. The Dropbox Business organization has no available licenses.
409
User is already on this team. The provided email address is associated with a user who is already a member of or invited to the team.
409
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.
Notes
  • Users in the "active" state have successfully logged into their Dropbox Business accounts, while users in the "invited" state have not.
  • 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".
  • 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 Dropbox Business announcements themselves.

/members/set_profile

Description
Updates a team member's profile.
URL structure
https://api.dropbox.com/1/team/members/set_profile
Method
POST
Permission
Team member management
Parameters
member_id
optional member ID. Must specify either a member_id or external_id.
external_id
optional external ID. Must specify either a member_id or external_id.
new_email
optional new email for member.
new_external_id
optional new external ID for member.
new_given_name
optional new given name for member.
new_surname
optional new surname for member.

Sample request body

{
  "member_id": "dbmid:efgh5678",
  "new_email": "jonathan.user@example.com",
  "new_given_name": "Jonathan"
}

Returns

Returns the profile of the updated member. See /members/get_info for a sample response.

Errors
400
Invalid parameters provided.
409
Any of the fields contain illegal characters.
409
Email is already reserved for another user.
409
The external id is already in use by another team member.
409
User is in the "invited" state. A user profile cannot be edited until the user is in the "active" state.
Notes
  • Exactly one of either a member_id or an 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.

/members/set_permissions

Description
Updates a team member's permissions.
URL structure
https://api.dropbox.com/1/team/members/set_permissions
Method
POST
Permission
Team member management
Parameters
member_id
optional member ID. Must specify either a member_id or external_id.
external_id
optional external ID. Must specify either a member_id or external_id.
new_is_admin
optional change the admin status of the member.

Sample request body

{
  "member_id": "dbmid:efgh5678",
  "new_is_admin": true
}

Returns

Returns the member's permissions.

Sample response body

{
  "member_id": "dbmid:efgh5678",
  "is_admin": true
}

Errors
400
Invalid parameters provided.
409
Cannot remove the admin setting of the last admin.
Notes
  • Exactly one of either a member_id or an external_id must be provided to identify the user account.

/members/send_welcome_email

Description
Sends welcome email to pending team member.
URL structure
https://api.dropbox.com/1/team/members/send_welcome_email
Method
POST
Permission
Team member management
Parameters
member_id
optional member ID. Must specify either a member_id or external_id.
external_id
optional external ID. Must specify either a member_id or external_id.

Sample request body

{
  "member_id": "dbmid:efgh5678",
}

Returns

Empty response

Errors
400
Expected a member_id or external_id.
400
Invalid member_id
400
Invalid parameters. This endpoint must include exactly one parameter.
Notes
  • Exactly one of either a member_id or an external_id must be provided to identify the user account.
  • No-op if team member is not pending.

/members/remove

Description
Removes a member from a team.
URL structure
https://api.dropbox.com/1/team/members/remove
Method
POST
Permission
Team member management
Parameters
member_id
optional member ID. Must specify either a member_id or external_id.
external_id
optional external ID. Must specify either a member_id or external_id.
transfer_dest_member_id
optional files from the deleted member account will be transferred to this member.
transfer_admin_member_id
optional errors during the transfer process will be sent via email to the transfer_admin_member_id.
delete_data
optional controls if the user's data will be deleted on their linked devices. Default is true.

Sample request body

{
  "member_id": "dbmid:efgh5678",
  "transfer_dest_member_id": "dbmid:abcd1234",
  "transfer_admin_member_id": "dbmid:abcd1234"
}

Returns

Empty response

Errors
400
Invalid parameters provided.
409
No matching user found. The provided member_id does not exist on this team.
409
Member has already been removed from the team.
409
Cannot remove the admin setting of the last admin.
Notes
  • Exactly one of either a member_id or an external_id must be provided to identify the user account.
  • This is not a deactivation where the account can be re-activated again. Calling add_member with the removed user's email address will create a new account with a new member_id that will not have access to any content that was shared with the initial account.

Group info

/groups/list

Description
Lists groups on a team.
URL structure
https://api.dropbox.com/1/team/groups/list
Method
POST
Permission
Team information
Parameters
None
Returns

A list of all groups on the team.

Sample response body

{
  "groups": [
    {
      "group_name": "Marketing",
      "group_id": "abcd1234",
      "num_members": 23
    },
    ...
  ]
}

/groups/get_info

Description
Retrieves information about one or more groups.
URL structure
https://api.dropbox.com/1/team/groups/get_info
Method
POST
Permission
Team information
Parameters
group_ids
list of group IDs

Sample request body

{
  "group_ids": ["abcd1234", "efgh5678"]
}

Returns

Information about one or more groups.

Sample response body

{
  "groups": [
    {
      "group_name": "Sales",
      "group_id": "abcd1234",
      "num_members": 2,
      "members": [
        {
          "profile": {
            "given_name": "John",
            "surname": "User",
            "status": "active",
            "member_id": "dbmid:efgh5678",
            "email": "john@example.com",
            "email_verified": true,
            "external_id": "09876"
          },
          "access_type": "member"
        },
        {
          "profile": {
            "given_name": "Jane",
            "surname": "User",
            "status": "active",
            "member_id": "dbmid:abcd1234",
            "email": "jane@example.com",
            "email_verified": true,
            "external_id": "54321"
          },
          "access_type": "owner"
        }
      ],
      "created": 1412635269
    },
    ...
  ]
}

Errors
400
Invalid parameters.
Notes
  • The created field is the group creation time as a UTC timestamp in milliseconds since the Unix epoch.

Group management

/groups/create

Description
Creates a new, empty group.
URL structure
https://api.dropbox.com/1/team/groups/create
Method
POST
Permission
Team member management
Parameters
group_name
group name

Sample request body

{
  "group_name": "Support agents"
}

Returns

Returns information about the created group.

Sample response body

{
  "group_name": "Support agents",
  "group_id": "ijkl9101",
  "num_members": 0,
  "members": [],
  "created": 1418244977
}

Errors
400
Group name already used.
Notes
  • This endpoint will make an empty group named group_name.
  • The created field is the group creation time as a UTC timestamp in milliseconds since the Unix epoch.
  • You can use the /groups/members/add endpoint to add members to the group.

/groups/delete

Description
Deletes a group.
URL structure
https://api.dropbox.com/1/team/groups/delete
Method
POST
Permission
Team member management
Parameters
group_id
group ID
Returns

Empty response

Errors
409
This group has already been deleted.
409
No matching group found. No groups match the specified group ID.

/groups/members/add

Description
Adds members to a group.
URL structure
https://api.dropbox.com/1/team/groups/members/add
Method
POST
Permission
Team member management
Parameters
group_id
group ID
members
list of member objects

Sample request body

{
  "group_id": "ijkl9101",
  "members": [
    {
      "team_member_id": "dbmid:efgh5678",
      "access_type": "member"
    },
    {
      "team_member_id": "dbmid:abcd1234",
      "access_type": "owner"
    }
  ]
}

Returns

Returns the updated group information.

Sample response body

{
  "group_name": "Support agents",
  "group_id": "ijkl9101",
  "num_members": 2,
  "members": [
    {
      "profile": {
        "given_name": "John",
        "surname": "User",
        "status": "active",
        "member_id": "dbmid:efgh5678",
        "email": "john@example.com",
        "email_verified": true,
        "external_id": "09876"
      },
      "access_type": "member"
    },
    {
      "profile": {
        "given_name": "Jane",
        "surname": "User",
        "status": "active",
        "member_id": "dbmid:abcd1234",
        "email": "jane@example.com",
        "email_verified": true,
        "external_id": "54321"
      },
      "access_type": "owner"
    }
  ],
  "created": 1418244977
}

Errors
409
You cannot add duplicate users. One or more of the members you are trying to add is already a member of the group.
409
Group is not in this team. You cannot add members to a group that is outside of your Dropbox Business team.
409
These members are not part of your team. Currently, you cannot add members to a group if they are not part of your Dropbox Business team, though this may change in a subsequent version. To add new members to your Dropbox Business team, use the /members/add endpoint.
409
No matching group found. No groups match the specified group ID.
Notes
  • The created field is the group creation time as a UTC timestamp in milliseconds since the Unix epoch.

/groups/members/remove

Description
Removes members from a group.
URL structure
https://api.dropbox.com/1/team/groups/members/remove
Method
POST
Permission
Team member management
Parameters
group_id
group ID
members
list of member objects

Sample request body

{
  "group_id": "ijkl9101",
  "members": [
    {
      "team_member_id": "dbmid:efgh5678"
    },
    {
      "team_member_id": "dbmid:abcd1234"
    }
  ]
}

Returns

Returns the updated group information. See /groups/members/add for a sample response.

Errors
409
User must be in the group. The provided team_member_id does not exist in this group.
409
Group is not in this team. You cannot remove members from a group that is outside of your Dropbox Business team.
409
No matching group found. No groups match the specified group ID.

/groups/members/set_access_type

Description
Sets a member's access type in a group.
URL structure
https://api.dropbox.com/1/team/groups/members/set_access_type
Method
POST
Permission
Team member management
Parameters
group_id
group ID
team_member_id
ID of the member whose access type is being changed
access_type
access type, either 'owner' or 'member'

Sample request body

{
  "group_id": "ijkl9101",
  "team_member_id": "dbmid:efgh5678",
  "access_type": "owner"
}

Returns

Returns the updated group information. See /groups/members/add for a sample response.

Errors
409
User must be in the group. The provided team_member_id does not exist in this group.
409
No matching group found. No groups match the specified group ID.

Reports

/reports/get_storage

Description
Retrieves reporting data about a team's storage usage.
URL structure
https://api.dropbox.com/1/team/reports/get_storage
Method
POST
Permission
Team information
Parameters
start_date
optional starting date (inclusive)
end_date
optional ending date (exclusive)

Dates should be in the format YYYY-MM-DD (partitioned on midnight UTC).

Sample request body

{
  "start_date": "2014-10-26"
}

Returns

Data about a team's storage usage. Each result is represented as an array ordered by date, where the first value corresponds to the data on the start_date. Each subsequent array value represents one day's data in that series.

Sample response body

{
  "start_date": "2014-10-26",
  "total_usage": [
    546626,
    498318,
    ...
  ],
  "shared_usage": [
    0,
    48308,
    ...
  ],
  "unshared_usage": [
    546626,
    498318,
    ...
  ],
  "shared_folders": [
    1,
    3,
    ...
  ],
  "member_storage_map": [
    {
      "100+GB": 0,
      "1GB": 2,
      ...
    },
    {
      "100GB": 0,
      "5GB": 0,
      ...
    }
  ]
}

Errors
400
Invalid start_date parameter.
400
Invalid end_date parameter.
Notes
  • start_date defaults to the earliest date tracked (current maximum is 6 months in the past), and end_date defaults to the current date.
  • Data is not available for the current day (partitioned on midnight UTC); there is an indeterminate delay as data is compiled before it is available for the previous day.
  • Arrays may terminate with null if data is not yet available for the last day.

/reports/get_activity

Description
Retrieves reporting data about a team's user activity.
URL structure
https://api.dropbox.com/1/team/reports/get_activity
Method
POST
Permission
Team information
Parameters
start_date
optional starting date (inclusive)
end_date
optional ending date (exclusive)

Dates should be in the format YYYY-MM-DD (partitioned on midnight UTC).

Sample request body

{
  "start_date": "2014-10-26"
}

Returns

Data about a team's user activity. Each result is represented as an array ordered by date, where the first value corresponds to the data on the start_date. Each subsequent array value represents one day's data in that series.

Sample response body

{
  "start_date": "2014-10-26",
  "active_users_1_day": [
    1,
    4,
    ...
  ],
  "active_users_7_day": [
    1,
    4,
    ...
  ],
  "active_users_28_day": [
    0,
    3,
    ...
  ],
  "adds": [
    14,
    23,
    ...
  ],
  "edits": [
    4,
    12,
    ...
  ],
  "deletes": [
    7,
    0,
    ...
  ],
  "active_shared_folders_1_day": [
    1,
    4,
    ...
  ],
  "active_shared_folders_7_day": [
    1,
    2,
    ...
  ],
  "active_shared_folders_28_day": [
    1,
    1,
    ...
  ],
  "shared_links_created": [
    4,
    9,
    ...
  ],
  "shared_links_viewed_total": [
    4,
    13,
    ...
  ],
  "shared_links_viewed_by_team": [
    2,
    36,
    ...
  ],
  "shared_links_viewed_by_outside_user": [
    1,
    22,
    ...
  ],
  "shared_links_viewed_by_not_logged_in": [
    0,
    13,
    ...
  ]
}

Errors
400
Invalid start_date parameter.
400
Invalid end_date parameter.
Notes
  • start_date defaults to the earliest date tracked (current maximum is 6 months in the past), and end_date defaults to the current date.
  • Data is not available for the current day (partitioned on midnight UTC); there is an indeterminate delay as data is compiled before it is available for the previous day.
  • Arrays may terminate with null if data is not yet available for the last day.

/reports/get_membership

Description
Retrieves reporting data about a team's membership.
URL structure
https://api.dropbox.com/1/team/reports/get_membership
Method
POST
Permission
Team information
Parameters
start_date
optional starting date (inclusive)
end_date
optional ending date (exclusive)

Dates should be in the format YYYY-MM-DD (partitioned on midnight UTC).

Sample request body

{
  "start_date": "2014-10-26"
}

Returns

Data about a team's membership. Each result is represented as an array ordered by date, where the first value corresponds to the data on the start_date. Each subsequent array value represents one day's data in that series.

Sample response body

{
  "start_date": "2014-10-26",
  "team_size": [
    1,
    4,
    ...
  ],
  "pending_invites": [
    1,
    0,
    ...
  ],
  "members_joined": [
    1,
    3,
    ...
  ],
  "licenses": [
    5,
    5,
    ...
  ]
}

Errors
400
Invalid start_date parameter.
400
Invalid end_date parameter.
Notes
  • start_date defaults to the earliest date tracked (current maximum is 6 months in the past), and end_date defaults to the current date.
  • Data is not available for the current day (partitioned on midnight UTC); there is an indeterminate delay as data is compiled before it is available for the previous day.
  • Arrays may terminate with null if data is not yet available for the last day.

/reports/get_devices

Description
Retrieves reporting data about a team's linked devices.
URL structure
https://api.dropbox.com/1/team/reports/get_devices
Method
POST
Permission
Team information
Parameters
start_date
optional starting date (inclusive)
end_date
optional ending date (exclusive)

Dates should be in the format YYYY-MM-DD (partitioned on midnight UTC).

Sample request body

{
  "start_date": "2014-10-26"
}

Returns

Data about a team's linked devices. Linked devices are those with a Dropbox client or mobile app installed and linked to a team member's Dropbox Business account. Each result is represented as an array ordered by date, where the first value corresponds to the data on the start_date. Each subsequent array value represents one day's data in that series.

Sample response body

{
  "start_date": "2014-10-26",
  "total_devices_1_day": [
    6,
    7,
    ...
  ],
  "total_devices_7_day": [
    4,
    7,
    ...
  ],
  "total_devices_28_day": [
    6,
    7,
    ...
  ],
  "ios_devices_1_day": [
    2,
    2,
    ...
  ],
  "ios_devices_7_day": [
    2,
    2,
    ...
  ],
  "ios_devices_28_day": [
    2,
    2,
    ...
  ],
  "android_devices_1_day": [
    1,
    2,
    ...
  ],
  "android_devices_7_day": [
    1,
    2,
    ...
  ],
  "android_devices_28_day": [
    1,
    2,
    ...
  ],
  "macos_devices_1_day": [
    4,
    4,
    ...
  ],
  "macos_devices_7_day": [
    4,
    4,
    ...
  ],
  "macos_devices_28_day": [
    0,
    4,
    ...
  ],
  "windows_devices_1_day": [
    0,
    1,
    ...
  ],
  "windows_devices_7_day": [
    0,
    1,
    ...
  ],
  "windows_devices_28_day": [
    0,
    0,
    ...
  ],
  "linux_devices_1_day": [
    1,
    1,
    ...
  ],
  "linux_devices_7_day": [
    1,
    1,
    ...
  ],
  "linux_devices_28_day": [
    1,
    1,
    ...
  ],
  "other_devices_1_day": [
    0,
    0,
    ...
  ],
  "other_devices_7_day": [
    0,
    0,
    ...
  ],
  "other_devices_28_day": [
    0,
    0,
    ...
  ]
}

Errors
400
Invalid start_date parameter.
400
Invalid end_date parameter.
Notes
  • start_date defaults to the earliest date tracked (current maximum is 6 months in the past), and end_date defaults to the current date.
  • Data is not available for the current day (partitioned on midnight UTC); there is an indeterminate delay as data is compiled before it is available for the previous day.
  • Arrays may terminate with null if data is not yet available for the last day.

Audit log

/log/get_events

Description
Accesses the Dropbox Business audit log for a team.
URL structure
https://api.dropbox.com/1/team/log/get_events
Method
POST
Permission
Team auditing
Parameters
limit
optional approximate maximum number of results to return per call (default 1000, maximum 1000)
cursor
optional encoded value indicating from what point to get the next limit logs
user
optional member ID, user ID, or email of an user for filtering events
category
optional filter the returned events to a single category (see Event types below)
start_ts
optional start time (UTC timestamp in milliseconds since the Unix epoch)
end_ts
optional end time (UTC timestamp in milliseconds since the Unix epoch)

Sample request body

{
  "user": {
    "member_id": "dbmid:efgh5678"
  },
  "category": "devices"
}

Returns

Audit log for a team.

Sample response body

{
  "events": [
    {
      "event_type": "member_join",
      "member_id": "dbmid:ijkl9012",
      "info_dict": {
        "initial_devices": "[]",
        "initial_apps": "[]"
      },
      "ip_address": "192.0.2.0",
      "user_id": 12345678,
      "name": "Jenny",
      "country": "US",
      "event_type_description": "Joined the team",
      "event_category": "members",
      "time": "2014-10-01T17:23:05+00:00",
      "email": "jenny@example.com"
    },
    {
      "event_type": "login_success",
      "member_id": "dbmid:efgh5678",
      "info_dict": null,
      "ip_address": "192.0.2.0",
      "user_id": 87654321,
      "name": "John",
      "country": "US",
      "event_type_description": "Signed in",
      "event_category": "logins",
      "time": "2014-10-03T01:16:32+00:00",
      "email": "john@example.com"
    },
    ...
  ],
  "has_more": true,
  "cursor": "abcd1234efgh5678"
}

Errors
400
Invalid cursor, limit, user, or type parameter.
400
Original parameters other than limit are not provided when using a cursor.
409
Filtering by a member_id that has never been on the team.
400
Invalid start_ts (occurs in the future).
400
Invalid start_ts and end_ts combination (start_ts > end_ts).
Notes
  • The limit is approximate. When one is specified, the endpoint may return as many as the larger of 2 * limit and 100 events.
  • If no parameters are specified, the endpoint will return the first 1000 events, along with cursor and has_more, indicating if there are more events in the log.
  • If a cursor is provided, only the limit parameter may be (optionally) changed; all other parameters should be provided with their original values.
  • When a user parameter is included, events will only be returned where that user is the actor or a target user. Users can be specified using an member_id, user_id or email. The value should be passed as a JSON dictionary specifying the chosen lookup method, e.g. {"email": "user@example.com"}
  • When a category parameter is included, only events matching the given category will be returned. Allowed category values are: apps, devices, groups, logins, members, passwords, sharing, and team_admin_actions.
  • The name, email, and user values for an event type, along with any entries in an event's info_dict, reflect the state of those values at the time the event occurred and may not reflect the current state of the Dropbox Business account.
  • The events sf_team_add_members and sf_nonteam_add_members will eventually replace sf_team_invite and sf_nonteam_invite for authenticated target users.
  • The events sf_team_mount and sf_nonteam_mount will eventually replace sf_team_join and sf_nonteam_join.
  • The events shared_content_team_view and shared_content_nonteam_view will eventually replace shmodel_team_view and shmodel_nonteam_view.
  • The events shared_content_team_download and shared_content_nonteam_download will eventually replace shmodel_team_download and shmodel_nonteam_download.
  • The events shared_content_team_copy and shared_content_nonteam_copy will eventually replace shmodel_team_copy and shmodel_nonteam_copy.
Event types

event_category event_type event_type_description
apps app_allow Authorized an application
apps app_remove Removed an application
apps team_app_allow Authorized a team application
apps team_app_remove Removed a team application
devices device_link Linked a device
devices device_unlink Removed a device
devices delete_on_unlink_success Successfully deleted files
devices delete_on_unlink_fail Failed to delete some files
groups group_created Created a group
groups group_renamed Renamed a group
groups group_deleted Deleted a group
groups group_moved Moved a group
groups group_members_added Added member to a group
groups group_members_removed Removed member from a group
groups group_membertype_changed Changed group member access type
logins login_success Signed in
logins login_fail Failed to sign in
logins sso_error Failed to sign in via SSO
members member_invite Invited a team member
members member_join Joined the team
members member_leave Removed a team member
members member_suspend Suspended a team member
members member_unsuspend Unsuspended a team member
members change_team_member_name Changed a team member's name
members domain_invites_email_existing_users Sent domain invites to existing domain accounts
members domain_invites_request_to_join_team Requested to join the team
members domain_invites_approve_request_to_join_team Approved a user request to join the team
members domain_invites_decline_request_to_join_team Declined a user request to join the team
members member_recover Recovered a removed member
passwords tfa_enable Enabled two-step verification
passwords tfa_disable Disabled two-step verification
passwords tfa_reset Reset two-step verification
passwords password_change Changed password
passwords reset_password Reset password
passwords reset_all_passwords Reset all passwords
passwords add_tfa_backup_phone Added two-step verification backup phone
passwords remove_tfa_backup_phone Removed two-step verification backup phone
passwords edit_tfa_backup_phone Edited two-step verification backup phone
passwords tfa_edit_authenticator Set two-step verification to use mobile app
passwords tfa_edit_sms Set two-step verification to use SMS
sharing shmodel_create Created a new link
sharing shmodel_nonteam_create Created a new link (non-team member)
sharing shmodel_disable Removed a link
sharing shmodel_visibility_public Made the contents of a link visible to anyone with the link
sharing shmodel_visibility_team_only Made the contents of a link visible to team members only
sharing shmodel_visibility_password Made the contents of a link password protected
sharing shmodel_set_expiration Set the expiration date of a link
sharing shmodel_remove_expiration Removed the expiration date of a link
sharing shmodel_team_view Opened a link (team member)
sharing shmodel_nonteam_view Opened a link (non-team member)
sharing shmodel_team_download Downloaded the contents of a link (team member)
sharing shmodel_nonteam_download Downloaded the contents of a link (non-team member)
sharing shmodel_team_copy Copied the contents of a link to their Dropbox (team member)
sharing shmodel_nonteam_copy Copied the contents of a link to their Dropbox (non-team member)
sharing shmodel_app_create Created a link to a file via an API app
sharing shmodel_team_share Shared a link with team members
sharing shmodel_nonteam_share Shared a link with non-team members
sharing shmodel_fb_share Shared a link with Facebook users
sharing shmodel_group_share Shared a link with a group
sharing sf_create Created a shared folder
sharing sf_team_invite Invited team member(s) to a shared folder
sharing sf_nonteam_invite Invited non-team member(s) to a shared folder
sharing sf_fb_invite Invited Facebook user(s) to a shared folder
sharing sf_team_claim_membership Claimed membership in a shared folder (team member)
sharing sf_nonteam_claim_membership Claimed membership in a shared folder (non-team member)
sharing sf_add_members Added team member(s) to a shared folder
sharing sf_add_group Added the team to a shared folder
sharing sf_invite_group Invited a group to a shared folder
sharing sf_team_uninvite Uninvited a team member from a shared folder
sharing sf_nonteam_uninvite Uninvited a non-team member from a shared folder
sharing sf_fb_uninvite Uninvited a Facebook user from a shared folder
sharing sf_team_decline Declined an invitation to a shared folder (team member)
sharing sf_nonteam_decline Declined an invitation to a shared folder (non-team member)
sharing sf_team_join Joined a shared folder (team member)
sharing sf_nonteam_join Joined a shared folder (non-team member)
sharing sf_team_kick Removed a team member from a shared folder
sharing sf_nonteam_kick Removed a non-team member from a shared folder
sharing sf_team_invite_change_role Changed a team member's role in a shared folder
sharing sf_nonteam_invite_change_role Changed a non-team member's role in a shared folder
sharing sf_fb_invite_change_role Changed a Facebook user's role in a shared folder
sharing sf_team_member_change_role Changed a team member's role in a shared folder
sharing sf_nonteam_member_change_role Changed a non-team member's role in a shared folder
sharing sf_team_leave Left a shared folder (team member)
sharing sf_nonteam_leave Left a shared folder (non-team member)
sharing sf_team_mount Mounted a shared folder (team member)
sharing sf_nonteam_mount Mounted a shared folder (non-team member)
sharing sf_team_unmount Unmounted a shared folder (team member)
sharing sf_nonteam_unmount Unmounted a shared folder (non-team member)
sharing sf_team_transfer Transferred folder ownership to a team member
sharing sf_nonteam_transfer Transferred folder ownership to a non-team member
sharing sf_unshare Unshared a folder
sharing shared_file_unshare Removed all members of a file and deleted the link
sharing sf_request_access Requested access to a shared folder
sharing sf_team_grant_access Added requesting user to a shared folder (team member)
sharing sf_nonteam_grant_access Added requesting user to a shared folder (non-team member)
sharing sf_allow_invite_team Prevented non-team members from being invited to a folder
sharing sf_allow_invite_anyone Allowed non-team members to be invited to a folder
sharing sf_allow_inviter_owner Prevented anyone but the owner from inviting people to a folder
sharing sf_allow_inviter_team Allowed any team member to invite people to a folder
sharing shared_file_public_link Made a file viewable to anyone with the link
sharing sf_public_link Made a folder viewable to anyone with the link
sharing shared_file_team_only_link Made a file viewable only to team members with the link
sharing sf_team_only_link Made a folder viewable only to team members with the link
sharing shared_file_member_only_link Made a file viewable only to members of the file
sharing sf_member_only_link Made a folder viewable only to members of the folder
sharing shared_file_add_password Added a password to a link to a file
sharing sf_add_password Added a password to a link to a folder
sharing shared_file_remove_password Removed the password from a link to a file
sharing sf_remove_password Removed the password from a link to a folder
sharing shared_file_change_password Changed the password for a link to a file
sharing sf_change_password Changed the password for a link to a folder
sharing shared_file_add_expiration Added an expiration date to a link to a file
sharing sf_add_expiration Added an expiration date to a link to a folder
sharing shared_file_remove_expiration Removed the expiration date from a link to a file
sharing sf_remove_expiration Removed the expiration date from a link to a folder
sharing shared_file_change_expiration Changed the expiration date for a link to a file
sharing sf_change_expiration Changed the expiration date for a link to a folder
sharing shared_file_viewer_info_on Turned on viewer info
sharing sf_viewer_info_on Turned on viewer info
sharing shared_file_viewer_info_off Turned off viewer info
sharing shared_file_downloads_on Turned on downloads
sharing shared_file_downloads_off Turned off downloads
sharing sf_downloads_off Turned off downloads
sharing sf_allow_team_to_view_shared_links Allowed only team members to view links to files in a shared folder
sharing sf_allow_anyone_to_view_shared_links Allowed anyone to view links to files in a shared folder
sharing group_sf_added Added a group to a shared folder
sharing group_sf_removed Removed a group from a shared folder
sharing group_sf_access_changed Changed group access to a shared folder
sharing collection_share Shared an album
sharing add_comment Added a new comment
sharing sf_allow_non_members_to_view_shared_links Allowed non collaborators to view links to files in a shared folder
sharing sf_block_non_members_from_viewing_shared_links Blocked non collaborators from viewing links to files in a shared folder
sharing shared_file_team_add_member Added a team member to a shared file
sharing shared_file_nonteam_add_member Added a non-team member to a shared file
sharing shared_file_nonteam_invite_member Invited a non-team member to a shared file
sharing shared_file_team_remove_member Removed a team member from a shared file
sharing shared_file_nonteam_remove_member Removed a non-team member from a shared file
sharing shared_file_team_change_role Changed the permission level of a team member
sharing shared_file_nonteam_change_role Changed the permission level of a non-team member
sharing shared_file_group_added Added a group to a shared file
sharing shared_file_group_removed Removed a group from a shared file
sharing shared_content_team_view A team member viewed content that was shared via a shared folder, shared file, or link
sharing shared_content_nonteam_view A non-team member viewed content that was shared via a shared folder, shared file, or link
sharing shared_content_team_copy A team member copied shared content to their Dropbox
sharing shared_content_nonteam_copy A non-team member copied shared content to their Dropbox
sharing shared_content_team_download A team member downloaded content that was shared via shared folder or file invitation
sharing shared_content_nonteam_download A non-team member downloaded content that was shared via shared folder or file invitation
sharing shared_file_team_claim A team member claimed an invitation to a file owned by your team
sharing shared_file_nonteam_claim A non-team member claimed an invitation to a file owned by your team
sharing shared_file_team_request_access A team member requested access to a file owned by your team
sharing shared_file_nonteam_request_access A non-team member requested access to a file owned by your team
sharing paper_doc_team_add_member Paper doc shared with a team member
sharing paper_doc_nonteam_add_member Paper doc shared with a non-team member
sharing paper_doc_team_view Paper doc viewed by a team member
sharing paper_doc_nonteam_view Paper doc viewed by a non-team member
sharing paper_folder_team_add_member Paper folder shared with a team member
sharing paper_folder_nonteam_add_member Paper folder shared with a non-team member
sharing paper_doc_post_comment Paper doc commented on
sharing paper_doc_edit_comment Paper doc comment edited
sharing paper_doc_delete_comment Paper doc comment deleted
sharing paper_doc_resolve_comment Paper doc comment resolved
sharing paper_doc_unresolve_comment Paper doc comment unresolved
sharing paper_doc_team_mention Team member mentioned on a Paper doc
sharing paper_doc_nonteam_mention Non-team member mentioned on a Paper doc
sharing paper_doc_team_request Access to a Paper doc requested from a team member
sharing paper_doc_nonteam_request Access to a Paper doc requested from a non-team member
sharing paper_doc_team_unshare team member removed from a Paper doc
sharing paper_doc_nonteam_unshare non-team member removed from a Paper doc
sharing paper_doc_access_changed Access permission level of a Paper doc changed
sharing paper_permission_edit Edit permission for a member of a Paper doc changed to: can edit
sharing paper_permission_comment Edit permission for a member of a Paper doc changed to: comment only
sharing paper_permission_view Edit permission for a member of a Paper doc changed to: view only
team_admin_actions sf_external_accept_allow Admin settings: team members can join shared folders outside the team
team_admin_actions sf_external_accept_forbid Admin settings: team members can't join shared folders outside the team
team_admin_actions sf_external_invite_allow Admin settings: folders can be shared outside the team
team_admin_actions sf_external_invite_warn Admin settings: team members see a warning before sharing folders outside the team
team_admin_actions sf_external_invite_forbid Admin settings: folders can't be shared outside the team
team_admin_actions shmodel_external_view_allow Admin settings: links can be viewed outside the team
team_admin_actions shmodel_external_view_default_private Admin settings: new links can't be viewed outside the team by default
team_admin_actions shmodel_external_view_forbid Admin settings: links can't be viewed outside the team
team_admin_actions force_tfa_enable Prevented disabling two-step verification
team_admin_actions force_tfa_disable Allowed disabling two-step verification
team_admin_actions disable_sso Disabled single sign-on
team_admin_actions allow_sso Allowed use of single sign-on
team_admin_actions require_sso Required use of single sign-on
team_admin_actions change_sso_url Changed single sign-on url
team_admin_actions remove_sso_url Removed single sign-on url
team_admin_actions update_sso_cert Updated single sign-on certificate
team_admin_actions change_saml_identity_mode Changed single sign-on identity mode
team_admin_actions make_admin Gave admin status
team_admin_actions remove_admin Removed admin status
team_admin_actions team_name_change Changed team name
team_admin_actions csv_download Created a team activity report
team_admin_actions twoaccount_desktop_enabled Enabled multiple accounts for desktop computers
team_admin_actions twoaccount_desktop_disabled Disabled multiple accounts for desktop computers
team_admin_actions groups_all_users_can_create Allowed all team members to create groups
team_admin_actions groups_only_admins_can_create Allowed only team admins to create groups
team_admin_actions domain_invites_set_invite_new_user_pref_to_yes Turned on 'Automatically invite new users'
team_admin_actions domain_invites_set_invite_new_user_pref_to_no Turned off 'Automatically invite new users'
team_admin_actions enabled_domain_invites Enabled sending domain invites
team_admin_actions disabled_domain_invites Disabled sending domain invites
team_admin_actions transfer_account_contents Transferred account contents
team_admin_actions permanently_delete_account_contents Permanently deleted account contents
team_admin_actions change_team_member_email Changed a team member's email address
team_admin_actions version_history_extended Opted out of extended version history change
team_admin_actions version_history_limited Accepted version history change
team_admin_actions paper_enabled Paper enabled for the team
team_admin_actions paper_disabled Paper disabled for the team
team_admin_actions paper_external_view_allow Paper external sharing policy changed to: anyone
team_admin_actions paper_external_view_default_team Paper external sharing policy changed to: default team
team_admin_actions paper_external_view_forbid Paper external sharing policy changed to: team-only
files add_files Add new files or folders
files download_files Download files from the webapp
files preview_files Preview files from the webapp
files delete_files Delete files or folders
files restore_files Restore deleted files or folders
files revert_files_to_previous_revision Revert files to previous revision
files rename_files Rename files or folders
files move_files Move files or folders
files copy_files Copy files or folders
files edit_files Edit files
files rollback_changes_in_files Rollback changes done in Dropbox Web for files or folders
files paper_doc_edited Paper doc edited
files paper_doc_created Paper doc created
files paper_doc_archived Paper doc archived
files paper_doc_permanently_deleted Paper doc permanently deleted
files paper_doc_restored Paper doc restored
files paper_doc_followed Paper doc followed
files paper_doc_subscription_level_changed Paper doc subscription level has changed
files paper_doc_docx_export Paper doc exported as docx
files paper_doc_html_export Paper doc exported as html
files paper_doc_md_export Paper doc exported as md
files paper_doc_renamed Paper doc renamed
files paper_doc_revision_restored Paper doc revision restored
files paper_folder_created Paper folder created
files paper_doc_added_to_folder Paper doc added to a folder
files paper_folder_added_to_folder Paper subfolder added to a folder
files paper_doc_removed_from_folder Paper doc removed from a folder
files paper_folder_archived Paper folder archived
files paper_folder_permanently_deleted Paper folder permanently deleted
files paper_folder_followed Paper folder followed
files paper_folder_subscription_level_changed The subscription level of a Paper folder has changed
files paper_folder_renamed Paper folder renamed
files paper_doc_slack_share Paper doc link shared via Slack
files paper_folder_restored Paper folder restored
files ransomware_detected Ransomware infection detected on a host
files ransomware_recovery_initiated Recovery of files affected by ransomware has begun
files ransomware_recovery_complete Recovery of files affected by ransomware has completed
files paper_doc_trashed Paper doc trashed
files paper_doc_untrashed Paper doc untrashed