Skip to content

Dropbox: Team schemas (part 1)

119 Dropbox schemas with complete fields and constraints.

← Team operations · All schemas

Add secondary emails to users — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
new_secondary_emailsarrayRequired within parent
new_secondary_emails[]ModelEach itemExpand Resend secondary email verification emails — request body — body emails to resend item

Referenced models: Resend secondary email verification emails — request body — body emails to resend item

Add secondary emails to users — response body

FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayRequired within parent
results[]ModelEach itemExpand Add secondary emails to users — response body — results item

Referenced models: Add secondary emails to users — response body — results item

Add secondary emails to users — response body — results item

FieldTypePresenceDescription and constraints
$JSONRootResult of trying to add secondary emails to a user. 'success' is the only value indicating that a user was successfully retrieved for adding secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 1).resultsarrayRequired within parent
$ (anyOf 1).results[]ModelEach itemExpand Add secondary emails to users — response body — results item tag success results item
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_user
$ (anyOf 2).invalid_userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: unverified
$ (anyOf 3).unverifiedModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: placeholder_user
$ (anyOf 4).placeholder_userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:success|invalid_user|unverified|placeholder_user)$)

Referenced models: Add secondary emails to users — response body — results item tag success results item, Sends welcome email to pending team member — request body — body

Add secondary emails to users — response body — results item tag success results item

FieldTypePresenceDescription and constraints
$JSONRootResult of trying to add a secondary email to a user. 'success' is the only value indicating that a secondary email was successfully added to a user. The other values explain the type of error that occurred, and include the email for which the error occurred.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).emailstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 1).is_verifiedbooleanRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: unavailable
$ (anyOf 2).unavailablestringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: already_pending
$ (anyOf 3).already_pendingstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: already_owned_by_user
$ (anyOf 4).already_owned_by_userstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: reached_limit
$ (anyOf 5).reached_limitstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: transient_error
$ (anyOf 6).transient_errorstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: too_many_updates
$ (anyOf 7).too_many_updatesstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: unknown_error
$ (anyOf 8).unknown_errorstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 9)objectAlternative
$ (anyOf 9)..tagstringRequired within parentMust equal: rate_limited
$ (anyOf 9).rate_limitedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 10)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 10)..tagstringRequired within parentPattern: ^(?!(?:success|unavailable|already_pending|already_owned_by_user|reached_limit|transient_error|too_many_updates|unknown_error|rate_limited)$)

Add users to member space limits excluded users list — request body — body

FieldTypePresenceDescription and constraints
$objectRootArgument of excluded users update operation. Should include a list of users to add/remove (according to endpoint), Maximum size of the list is 1000 users.
usersJSONOptional
users (anyOf 1)arrayAlternative
users (anyOf 1)[]ModelEach itemExpand Sends welcome email to pending team member — request body — body
users (anyOf 2)nullAlternative

Referenced models: Sends welcome email to pending team member — request body — body

Add users to member space limits excluded users list — response body

FieldTypePresenceDescription and constraints
$objectRootExcluded users update result.
statusModelRequired within parentExpand Add users to member space limits excluded users list — response body — status

Referenced models: Add users to member space limits excluded users list — response body — status

Add users to member space limits excluded users list — response body — status

FieldTypePresenceDescription and constraints
$JSONRootExcluded users update operation status.
$ (anyOf 1)stringAlternativeKnown values: success
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: success
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:success)$)

Changes an active team folder's name — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
namestringRequired within parent

Changes an active team folder's name — response body

FieldTypePresenceDescription and constraints
$objectRootProperties of a team folder.
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
namestringRequired within parent
statusModelRequired within parentExpand Changes an active team folder's name — response body — status
is_team_shared_dropboxbooleanRequired within parent
sync_settingModelRequired within parentExpand Changes an active team folder's name — response body — sync setting
content_sync_settingsarrayRequired within parent
content_sync_settings[]ModelEach itemExpand Changes an active team folder's name — response body — content sync settings item
quota_limitJSONOptional
quota_limit (anyOf 1)integerAlternative
quota_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Changes an active team folder's name — response body — content sync settings item, Changes an active team folder's name — response body — sync setting, Changes an active team folder's name — response body — status

Changes an active team folder's name — response body — content sync settings item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentMinimum length: 4
Pattern: ^(?:id:.+)$
sync_settingModelRequired within parentExpand Changes an active team folder's name — response body — sync setting

Referenced models: Changes an active team folder's name — response body — sync setting

Changes an active team folder's name — response body — status

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: active, archived, archive_in_progress, inactive
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: active
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: archived
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: archive_in_progress
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: inactive
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:active|archived|archive_in_progress|inactive)$)

Changes an active team folder's name — response body — sync setting

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: default, not_synced, not_synced_inactive
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: default
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: not_synced
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: not_synced_inactive
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:default|not_synced|not_synced_inactive)$)

Continue listing member space limits excluded users — request body — body

FieldTypePresenceDescription and constraints
$objectRootExcluded users list continue argument.
cursorstringRequired within parent

Continue listing the file metadata that's under the hold — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentPattern: ^(?:^pid_dbhid:.+)$
cursorJSONOptional
cursor (anyOf 1)stringAlternativeMinimum length: 1
cursor (anyOf 2)nullAlternative

Creates a new, active, team folder with no members — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parent
sync_settingJSONOptional
sync_setting (anyOf 1)ModelAlternativeExpand Creates a new, active, team folder with no members — request body — body sync setting value
sync_setting (anyOf 2)nullAlternative

Referenced models: Creates a new, active, team folder with no members — request body — body sync setting value

Creates a new, active, team folder with no members — request body — body sync setting value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: default, not_synced
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: default
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: not_synced
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:default|not_synced)$)

Creates a new, empty group, with a requested name — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
group_namestringRequired within parent
add_creator_as_ownerbooleanOptional
group_external_idJSONOptional
group_external_id (anyOf 1)stringAlternative
group_external_id (anyOf 2)nullAlternative
group_management_typeJSONOptional
group_management_type (anyOf 1)ModelAlternativeExpand Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed
group_management_type (anyOf 2)nullAlternative

Referenced models: Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed

Creates a new, empty group, with a requested name — request body — body group management type The group type determines how a group is managed

FieldTypePresenceDescription and constraints
$JSONRootThe group type determines how a group is managed.
$ (anyOf 1)stringAlternativeOne of: user_managed, company_managed, system_managed
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: user_managed
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: company_managed
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: system_managed
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:user_managed|company_managed|system_managed)$)

Creates new legal hold policy — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentMaximum length: 140
descriptionJSONOptional
description (anyOf 1)stringAlternativeMaximum length: 501
description (anyOf 2)nullAlternative
membersarrayRequired within parent
members[]stringEach item
start_dateJSONOptional
start_date (anyOf 1)stringAlternative
start_date (anyOf 2)nullAlternative
end_dateJSONOptional
end_date (anyOf 1)stringAlternative
end_date (anyOf 2)nullAlternative

Delete secondary emails from users Permission : Team member management — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
emails_to_deletearrayRequired within parent
emails_to_delete[]ModelEach itemExpand Resend secondary email verification emails — request body — body emails to resend item

Referenced models: Resend secondary email verification emails — request body — body emails to resend item

Delete secondary emails from users Permission : Team member management — response body

FieldTypePresenceDescription and constraints
$objectRoot
resultsarrayRequired within parent
results[]ModelEach itemExpand Delete secondary emails from users Permission : Team member management — response body — results item

Referenced models: Delete secondary emails from users Permission : Team member management — response body — results item

Delete secondary emails from users Permission : Team member management — response body — results item

FieldTypePresenceDescription and constraints
$JSONRootResult of trying to delete a user's secondary emails. 'success' is the only value indicating that a user was successfully retrieved for deleting secondary emails. The other values explain the type of error that occurred, and include the user for which the error occurred.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 1).resultsarrayRequired within parent
$ (anyOf 1).results[]ModelEach itemExpand Delete secondary emails from users Permission : Team member management — response body — results item tag success results item
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_user
$ (anyOf 2).invalid_userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:success|invalid_user)$)

Referenced models: Delete secondary emails from users Permission : Team member management — response body — results item tag success results item, Sends welcome email to pending team member — request body — body

Delete secondary emails from users Permission : Team member management — response body — results item tag success results item

FieldTypePresenceDescription and constraints
$JSONRootResult of trying to delete a secondary email address. 'success' is the only value indicating that a secondary email was successfully deleted. The other values explain the type of error that occurred, and include the email for which the error occurred.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).successstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: not_found
$ (anyOf 2).not_foundstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: cannot_remove_primary
$ (anyOf 3).cannot_remove_primarystringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:success|not_found|cannot_remove_primary)$)

Deletes a group — request body — body

FieldTypePresenceDescription and constraints
$JSONRootArgument for selecting a single group, either by group_id or by external group ID.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: group_id
$ (anyOf 1).group_idstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: group_external_id
$ (anyOf 2).group_external_idstringRequired within parent

Deletes a group — request body — headers Dropbox-API-Path-Root

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeOne of: home
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: home
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: root
$ (anyOf 3).rootstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: namespace_id
$ (anyOf 4).namespace_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:home|root|namespace_id)$)

Deletes a group — response body

FieldTypePresenceDescription and constraints
$JSONRootResult returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.
$ (anyOf 1)stringAlternativeKnown values: complete
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: async_job_id
$ (anyOf 2).async_job_idstringRequired within parentMinimum length: 1
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete

Deletes a team member's profile photo — team members Delete Profile Photo — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body

Referenced models: Sends welcome email to pending team member — request body — body

Get available Team Member Roles for the connected team — response body

FieldTypePresenceDescription and constraints
$objectRootAvailable TeamMemberRole for the connected team. To be used with members/set_admin_permissions:2.
rolesarrayRequired within parent
roles[]ModelEach itemExpand Get available Team Member Roles for the connected team — response body — roles item

Referenced models: Get available Team Member Roles for the connected team — response body — roles item

Get available Team Member Roles for the connected team — response body — roles item

FieldTypePresenceDescription and constraints
$objectRootA role which can be attached to a team member. This replaces AdminTier; each AdminTier corresponds to a new TeamMemberRole with a matching name.
role_idstringRequired within parentMaximum length: 128
Pattern: ^(?:pid_dbtmr:.*)$
namestringRequired within parentMaximum length: 32
descriptionstringRequired within parentMaximum length: 256

Get the values for one or more features — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
featuresarrayRequired within parent
features[]ModelEach itemExpand Get the values for one or more features — request body — body features item

Referenced models: Get the values for one or more features — request body — body features item

Get the values for one or more features — request body — body features item

FieldTypePresenceDescription and constraints
$JSONRootA set of features that a Dropbox Business account may support.
$ (anyOf 1)stringAlternativeOne of: upload_api_rate_limit, has_team_shared_dropbox, has_team_file_events, has_team_selective_sync, has_distinct_member_homes
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: upload_api_rate_limit
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: has_team_shared_dropbox
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: has_team_file_events
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: has_team_selective_sync
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: has_distinct_member_homes
$ (anyOf 7)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tagstringRequired within parentPattern: ^(?!(?:upload_api_rate_limit|has_team_shared_dropbox|has_team_file_events|has_team_selective_sync|has_distinct_member_homes)$)

Get the values for one or more features — response body

FieldTypePresenceDescription and constraints
$objectRoot
valuesarrayRequired within parent
values[]ModelEach itemExpand Get the values for one or more features — response body — values item

Referenced models: Get the values for one or more features — response body — values item

Get the values for one or more features — response body — values item

FieldTypePresenceDescription and constraints
$JSONRootThe values correspond to entries in Feature. You may get different value according to your Dropbox Business plan.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: upload_api_rate_limit
$ (anyOf 1).upload_api_rate_limitModelRequired within parentExpand Get the values for one or more features — response body — values item tag upload api rate limit upload api rate limit
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: has_team_shared_dropbox
$ (anyOf 2).has_team_shared_dropboxModelRequired within parentExpand Get the values for one or more features — response body — values item tag has team shared dropbox has team shared dropbox
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: has_team_file_events
$ (anyOf 3).has_team_file_eventsModelRequired within parentExpand Get the values for one or more features — response body — values item tag has team file events has team file events
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: has_team_selective_sync
$ (anyOf 4).has_team_selective_syncModelRequired within parentExpand Get the values for one or more features — response body — values item tag has team selective sync has team selective sync
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: has_distinct_member_homes
$ (anyOf 5).has_distinct_member_homesModelRequired within parentExpand Get the values for one or more features — response body — values item tag has distinct member homes has distinct member homes
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:upload_api_rate_limit|has_team_shared_dropbox|has_team_file_events|has_team_selective_sync|has_distinct_member_homes)$)

Referenced models: Get the values for one or more features — response body — values item tag has distinct member homes has distinct member homes, Get the values for one or more features — response body — values item tag has team file events has team file events, Get the values for one or more features — response body — values item tag has team selective sync has team selective sync, Get the values for one or more features — response body — values item tag has team shared dropbox has team shared dropbox, Get the values for one or more features — response body — values item tag upload api rate limit upload api rate limit

Get the values for one or more features — response body — values item tag has distinct member homes has distinct member homes

FieldTypePresenceDescription and constraints
$JSONRootThe value for Feature.has_distinct_member_homes.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: has_distinct_member_homes
$ (anyOf 1).has_distinct_member_homesbooleanRequired within parent
$ (anyOf 2)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tagstringRequired within parentPattern: ^(?!(?:has_distinct_member_homes)$)

Get the values for one or more features — response body — values item tag has team file events has team file events

FieldTypePresenceDescription and constraints
$JSONRootThe value for Feature.has_team_file_events.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: enabled
$ (anyOf 1).enabledbooleanRequired within parent
$ (anyOf 2)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tagstringRequired within parentPattern: ^(?!(?:enabled)$)

Get the values for one or more features — response body — values item tag has team selective sync has team selective sync

FieldTypePresenceDescription and constraints
$JSONRootThe value for Feature.has_team_selective_sync.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: has_team_selective_sync
$ (anyOf 1).has_team_selective_syncbooleanRequired within parent
$ (anyOf 2)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tagstringRequired within parentPattern: ^(?!(?:has_team_selective_sync)$)

Get the values for one or more features — response body — values item tag has team shared dropbox has team shared dropbox

FieldTypePresenceDescription and constraints
$JSONRootThe value for Feature.has_team_shared_dropbox.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: has_team_shared_dropbox
$ (anyOf 1).has_team_shared_dropboxbooleanRequired within parent
$ (anyOf 2)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tagstringRequired within parentPattern: ^(?!(?:has_team_shared_dropbox)$)

Get the values for one or more features — response body — values item tag upload api rate limit upload api rate limit

FieldTypePresenceDescription and constraints
$JSONRootThe value for Feature.upload_api_rate_limit.
$ (anyOf 1)stringAlternativeKnown values: unlimited
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: unlimited
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: limit
$ (anyOf 3).limitJSONRequired within parent
$ (anyOf 3).limit (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 3).limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:unlimited|limit)$)

Get users custom quota — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
usersarrayRequired within parent
users[]ModelEach itemExpand Sends welcome email to pending team member — request body — body

Referenced models: Sends welcome email to pending team member — request body — body

Get users custom quota — response body — item

FieldTypePresenceDescription and constraints
$JSONRootUser custom quota.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 1).quota_gbJSONOptional
$ (anyOf 1).quota_gb (anyOf 1)ModelAlternativeExpand Get users custom quota — response body — item tag success quota gb value
$ (anyOf 1).quota_gb (anyOf 2)nullAlternative
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_user
$ (anyOf 2).invalid_userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:success|invalid_user)$)

Referenced models: Get users custom quota — response body — item tag success quota gb value, Sends welcome email to pending team member — request body — body

Get users custom quota — response body — item tag success quota gb value

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativeMinimum: 2
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Gets a legal hold by Id — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentPattern: ^(?:^pid_dbhid:.+)$

Launch a member suspension batch — request body — body

FieldTypePresenceDescription and constraints
$objectRootLaunches one action-specific member suspension batch job.
membersarrayRequired within parentMaximum items: 500
Minimum items: 1
members[]ModelEach itemExpand Launch a member suspension batch — request body — body members item

Referenced models: Launch a member suspension batch — request body — body members item

Launch a member suspension batch — request body — body members item

FieldTypePresenceDescription and constraints
$objectRootOne member selected for suspension. The opaque client item ID correlates the eventual report row with the caller's input without sending CSV data.
client_item_idstringRequired within parentMaximum length: 128
Minimum length: 1
suspend_argModelRequired within parentExpand Suspend a member from a team — request body — body

Referenced models: Suspend a member from a team — request body — body

Launch a member suspension batch — response body

FieldTypePresenceDescription and constraints
$JSONRootResult returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: async_job_id
$ (anyOf 1).async_job_idstringRequired within parentMinimum length: 1

List all applications linked to the team members' accounts — request body — body

FieldTypePresenceDescription and constraints
$objectRootArguments for linked_apps/list_members_linked_apps.
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

List all applications linked to the team members' accounts — response body

FieldTypePresenceDescription and constraints
$objectRootInformation returned by linked_apps/list_members_linked_apps.
appsarrayRequired within parent
apps[]ModelEach itemExpand List all applications linked to the team members' accounts — response body — apps item
has_morebooleanRequired within parent
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

Referenced models: List all applications linked to the team members' accounts — response body — apps item

List all applications linked to the team members' accounts — response body — apps item

FieldTypePresenceDescription and constraints
$objectRootInformation on linked applications of a team member.
team_member_idstringRequired within parent
linked_api_appsarrayRequired within parent
linked_api_apps[]ModelEach itemExpand List all linked applications of the team member — response body — linked api apps item

Referenced models: List all linked applications of the team member — response body — linked api apps item

List all device sessions of a team — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative
include_web_sessionsbooleanOptional
include_desktop_clientsbooleanOptional
include_mobile_clientsbooleanOptional

List all device sessions of a team — response body

FieldTypePresenceDescription and constraints
$objectRoot
devicesarrayRequired within parent
devices[]ModelEach itemExpand List all device sessions of a team — response body — devices item
has_morebooleanRequired within parent
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative

Referenced models: List all device sessions of a team — response body — devices item

List all device sessions of a team — response body — devices item

FieldTypePresenceDescription and constraints
$objectRootInformation on devices of a team's member.
team_member_idstringRequired within parent
web_sessionsJSONOptional
web_sessions (anyOf 1)arrayAlternative
web_sessions (anyOf 1)[]ModelEach itemExpand List all device sessions of a team's member — response body — active web sessions array item
web_sessions (anyOf 2)nullAlternative
desktop_clientsJSONOptional
desktop_clients (anyOf 1)arrayAlternative
desktop_clients (anyOf 1)[]ModelEach itemExpand List all device sessions of a team's member — response body — desktop client sessions array item
desktop_clients (anyOf 2)nullAlternative
mobile_clientsJSONOptional
mobile_clients (anyOf 1)arrayAlternative
mobile_clients (anyOf 1)[]ModelEach itemExpand List all device sessions of a team's member — response body — mobile client sessions array item
mobile_clients (anyOf 2)nullAlternative

Referenced models: List all device sessions of a team's member — response body — active web sessions array item, List all device sessions of a team's member — response body — desktop client sessions array item, List all device sessions of a team's member — response body — mobile client sessions array item

List all device sessions of a team's member — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
team_member_idstringRequired within parent
include_web_sessionsbooleanOptional
include_desktop_clientsbooleanOptional
include_mobile_clientsbooleanOptional

List all device sessions of a team's member — response body

FieldTypePresenceDescription and constraints
$objectRoot
active_web_sessionsJSONOptional
active_web_sessions (anyOf 1)arrayAlternative
active_web_sessions (anyOf 1)[]ModelEach itemExpand List all device sessions of a team's member — response body — active web sessions array item
active_web_sessions (anyOf 2)nullAlternative
desktop_client_sessionsJSONOptional
desktop_client_sessions (anyOf 1)arrayAlternative
desktop_client_sessions (anyOf 1)[]ModelEach itemExpand List all device sessions of a team's member — response body — desktop client sessions array item
desktop_client_sessions (anyOf 2)nullAlternative
mobile_client_sessionsJSONOptional
mobile_client_sessions (anyOf 1)arrayAlternative
mobile_client_sessions (anyOf 1)[]ModelEach itemExpand List all device sessions of a team's member — response body — mobile client sessions array item
mobile_client_sessions (anyOf 2)nullAlternative

Referenced models: List all device sessions of a team's member — response body — active web sessions array item, List all device sessions of a team's member — response body — desktop client sessions array item, List all device sessions of a team's member — response body — mobile client sessions array item

List all device sessions of a team's member — response body — active web sessions array item

FieldTypePresenceDescription and constraints
$objectRootInformation on active web sessions.
session_idstringRequired within parent
ip_addressJSONOptional
ip_address (anyOf 1)stringAlternative
ip_address (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
createdJSONOptional
created (anyOf 1)stringAlternative
created (anyOf 2)nullAlternative
updatedJSONOptional
updated (anyOf 1)stringAlternative
updated (anyOf 2)nullAlternative
user_agentstringRequired within parent
osstringRequired within parent
browserstringRequired within parent
expiresJSONOptional
expires (anyOf 1)stringAlternative
expires (anyOf 2)nullAlternative

List all device sessions of a team's member — response body — desktop client sessions array item

FieldTypePresenceDescription and constraints
$objectRootInformation about linked Dropbox desktop client sessions.
session_idstringRequired within parent
ip_addressJSONOptional
ip_address (anyOf 1)stringAlternative
ip_address (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
createdJSONOptional
created (anyOf 1)stringAlternative
created (anyOf 2)nullAlternative
updatedJSONOptional
updated (anyOf 1)stringAlternative
updated (anyOf 2)nullAlternative
host_namestringRequired within parent
client_typeModelRequired within parentExpand List all device sessions of a team's member — response body — desktop client sessions array item client type
client_versionstringRequired within parent
platformstringRequired within parent
is_delete_on_unlink_supportedbooleanRequired within parent

Referenced models: List all device sessions of a team's member — response body — desktop client sessions array item client type

List all device sessions of a team's member — response body — desktop client sessions array item client type

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: windows, mac, linux
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: windows
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: mac
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: linux
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:windows|mac|linux)$)

List all device sessions of a team's member — response body — mobile client sessions array item

FieldTypePresenceDescription and constraints
$objectRootInformation about linked Dropbox mobile client sessions.
session_idstringRequired within parent
ip_addressJSONOptional
ip_address (anyOf 1)stringAlternative
ip_address (anyOf 2)nullAlternative
countryJSONOptional
country (anyOf 1)stringAlternative
country (anyOf 2)nullAlternative
createdJSONOptional
created (anyOf 1)stringAlternative
created (anyOf 2)nullAlternative
updatedJSONOptional
updated (anyOf 1)stringAlternative
updated (anyOf 2)nullAlternative
device_namestringRequired within parent
client_typeModelRequired within parentExpand List all device sessions of a team's member — response body — mobile client sessions array item client type
client_versionJSONOptional
client_version (anyOf 1)stringAlternative
client_version (anyOf 2)nullAlternative
os_versionJSONOptional
os_version (anyOf 1)stringAlternative
os_version (anyOf 2)nullAlternative
last_carrierJSONOptional
last_carrier (anyOf 1)stringAlternative
last_carrier (anyOf 2)nullAlternative

Referenced models: List all device sessions of a team's member — response body — mobile client sessions array item client type

List all device sessions of a team's member — response body — mobile client sessions array item client type

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: iphone, ipad, android, windows_phone, blackberry
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: iphone
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: ipad
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: android
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: windows_phone
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: blackberry
$ (anyOf 7)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tagstringRequired within parentPattern: ^(?!(?:iphone|ipad|android|windows_phone|blackberry)$)

List all linked applications of the team member — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
team_member_idstringRequired within parent

List all linked applications of the team member — response body

FieldTypePresenceDescription and constraints
$objectRoot
linked_api_appsarrayRequired within parent
linked_api_apps[]ModelEach itemExpand List all linked applications of the team member — response body — linked api apps item

Referenced models: List all linked applications of the team member — response body — linked api apps item

List all linked applications of the team member — response body — linked api apps item

FieldTypePresenceDescription and constraints
$objectRootInformation on linked third party applications.
app_idstringRequired within parent
app_namestringRequired within parent
publisherJSONOptional
publisher (anyOf 1)stringAlternative
publisher (anyOf 2)nullAlternative
publisher_urlJSONOptional
publisher_url (anyOf 1)stringAlternative
publisher_url (anyOf 2)nullAlternative
linkedJSONOptional
linked (anyOf 1)stringAlternative
linked (anyOf 2)nullAlternative
is_app_folderbooleanRequired within parent

List member space limits excluded users — request body — body

FieldTypePresenceDescription and constraints
$objectRootExcluded users list argument.
limitintegerOptionalMinimum: 1
Maximum: 1000

List member space limits excluded users — response body

FieldTypePresenceDescription and constraints
$objectRootExcluded users list result.
usersarrayRequired within parent
users[]ModelEach itemExpand List member space limits excluded users — response body — users item
cursorJSONOptional
cursor (anyOf 1)stringAlternative
cursor (anyOf 2)nullAlternative
has_morebooleanRequired within parent

Referenced models: List member space limits excluded users — response body — users item

List member space limits excluded users — response body — users item

FieldTypePresenceDescription and constraints
$objectRootBasic member profile.
team_member_idstringRequired within parent
external_idJSONOptional
external_id (anyOf 1)stringAlternative
external_id (anyOf 2)nullAlternative
account_idJSONOptional
account_id (anyOf 1)stringAlternativeMaximum length: 40
Minimum length: 40
account_id (anyOf 2)nullAlternative
emailstringRequired within parent
email_verifiedbooleanRequired within parent
secondary_emailsJSONOptional
secondary_emails (anyOf 1)arrayAlternative
secondary_emails (anyOf 1)[]ModelEach itemExpand Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item
secondary_emails (anyOf 2)nullAlternative
statusModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile status
nameModelRequired within parentExpand Get information about a user's account — response body — name
membership_typeModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile membership type
invited_onJSONOptional
invited_on (anyOf 1)stringAlternative
invited_on (anyOf 2)nullAlternative
joined_onJSONOptional
joined_on (anyOf 1)stringAlternative
joined_on (anyOf 2)nullAlternative
suspended_onJSONOptional
suspended_on (anyOf 1)stringAlternative
suspended_on (anyOf 2)nullAlternative
persistent_idJSONOptional
persistent_id (anyOf 1)stringAlternative
persistent_id (anyOf 2)nullAlternative
is_directory_restrictedJSONOptional
is_directory_restricted (anyOf 1)booleanAlternative
is_directory_restricted (anyOf 2)nullAlternative
profile_photo_urlJSONOptional
profile_photo_url (anyOf 1)stringAlternative
profile_photo_url (anyOf 2)nullAlternative

Referenced models: Updates a team member's profile — team members Set Profile — response body — profile secondary emails array item, Updates a team member's profile — team members Set Profile — response body — profile status, Updates a team member's profile — team members Set Profile — response body — profile membership type, Get information about a user's account — response body — name

List the file metadata that's under the hold — response body

FieldTypePresenceDescription and constraints
$objectRoot
entriesarrayRequired within parent
entries[]ModelEach itemExpand List the file metadata that's under the hold — response body — entries item
cursorJSONOptional
cursor (anyOf 1)stringAlternativeMinimum length: 1
cursor (anyOf 2)nullAlternative
has_morebooleanRequired within parent

Referenced models: List the file metadata that's under the hold — response body — entries item

List the file metadata that's under the hold — response body — entries item

FieldTypePresenceDescription and constraints
$objectRoot
new_filenamestringRequired within parent
original_revision_idstringRequired within parentMinimum length: 9
Pattern: ^(?:[0-9a-f]+)$
original_file_pathstringRequired within parentPattern: ^(?:(/(.|[\r\n])*)?)$
server_modifiedstringRequired within parent
author_member_idstringRequired within parent
author_member_statusModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile status
author_emailstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
file_typestringRequired within parent
sizeJSONRequired within parent
size (anyOf 1)integerAlternativeMinimum: 0
size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
content_hashstringRequired within parentMaximum length: 64
Minimum length: 64

Referenced models: Updates a team member's profile — team members Set Profile — response body — profile status

Lists all team folders — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
limitintegerOptionalMinimum: 1
Maximum: 1000

Lists all team folders — response body

FieldTypePresenceDescription and constraints
$objectRootResult for team_folder/list and team_folder/list/continue.
team_foldersarrayRequired within parent
team_folders[]ModelEach itemExpand Changes an active team folder's name — response body
cursorstringRequired within parent
has_morebooleanRequired within parent

Referenced models: Changes an active team folder's name — response body

Lists groups on a team — response body

FieldTypePresenceDescription and constraints
$objectRoot
groupsarrayRequired within parent
groups[]ModelEach itemExpand Lists groups on a team — response body — groups item
cursorstringRequired within parent
has_morebooleanRequired within parent

Referenced models: Lists groups on a team — response body — groups item

Lists groups on a team — response body — groups item

FieldTypePresenceDescription and constraints
$objectRootInformation about a group.
group_namestringRequired within parent
group_idstringRequired within parent
group_external_idJSONOptional
group_external_id (anyOf 1)stringAlternative
group_external_id (anyOf 2)nullAlternative
member_countJSONOptional
member_count (anyOf 1)JSONAlternative
member_count (anyOf 1) (anyOf 1)integerAlternativeMinimum: 0
member_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
member_count (anyOf 2)nullAlternative
group_management_typeModelRequired within parentExpand Updates a group's name and or external ID — response body — group management type

Referenced models: Updates a group's name and or external ID — response body — group management type

Lists legal holds on a team — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
include_releasedbooleanOptional

Lists legal holds on a team — response body

FieldTypePresenceDescription and constraints
$objectRoot
policiesarrayRequired within parent
policies[]ModelEach itemExpand Updates a legal hold — response body

Referenced models: Updates a legal hold — response body

Lists members of a group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
groupModelRequired within parentExpand Deletes a group — request body — body
limitintegerOptionalMinimum: 1
Maximum: 1000

Referenced models: Deletes a group — request body — body

Lists members of a group — response body

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parent
members[]ModelEach itemExpand Lists members of a group — response body — members item
cursorstringRequired within parent
has_morebooleanRequired within parent

Referenced models: Lists members of a group — response body — members item

Lists members of a group — response body — members item

FieldTypePresenceDescription and constraints
$objectRootProfile of group member, and role in group.
profileModelRequired within parentExpand List member space limits excluded users — response body — users item
access_typeModelRequired within parentExpand Lists members of a group — response body — members item access type

Referenced models: Lists members of a group — response body — members item access type, List member space limits excluded users — response body — users item

Lists members of a group — response body — members item access type

FieldTypePresenceDescription and constraints
$JSONRootRole of a user in group.
$ (anyOf 1)stringAlternativeKnown values: member, owner
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: member
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: owner

Lists members of a team — team members List V2 — response body

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parent
members[]ModelEach itemExpand Updates a team member's profile — team members Set Profile V2 — response body — member info
cursorstringRequired within parent
has_morebooleanRequired within parent

Referenced models: Updates a team member's profile — team members Set Profile V2 — response body — member info

Lists members of a team — team members List — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
limitintegerOptionalMinimum: 1
Maximum: 1000
include_removedbooleanOptional

Lists members of a team — team members List — response body

FieldTypePresenceDescription and constraints
$objectRoot
membersarrayRequired within parent
members[]ModelEach itemExpand Updates a team member's profile — team members Set Profile — response body
cursorstringRequired within parent
has_morebooleanRequired within parent

Referenced models: Updates a team member's profile — team members Set Profile — response body

Moves removed member's files to a different member — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
transfer_dest_idModelRequired within parentExpand Sends welcome email to pending team member — request body — body
transfer_admin_idModelRequired within parentExpand Sends welcome email to pending team member — request body — body

Referenced models: Sends welcome email to pending team member — request body — body

Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete
$ (anyOf 3).completearrayRequired within parent
$ (anyOf 3).complete[]ModelEach itemExpand Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedstringRequired within parent

Referenced models: Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item

Once an async job id is returned from members add , use this to poll the status of the asynchronous request — response body — tag complete complete item

FieldTypePresenceDescription and constraints
$JSONRootDescribes 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.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: team_license_limit
$ (anyOf 1).team_license_limitstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: free_team_member_limit_reached
$ (anyOf 2).free_team_member_limit_reachedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: user_already_on_team
$ (anyOf 3).user_already_on_teamstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: user_on_another_team
$ (anyOf 4).user_on_another_teamstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: user_already_paired
$ (anyOf 5).user_already_pairedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: user_migration_failed
$ (anyOf 6).user_migration_failedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: duplicate_external_member_id
$ (anyOf 7).duplicate_external_member_idstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: duplicate_member_persistent_id
$ (anyOf 8).duplicate_member_persistent_idstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 9)objectAlternative
$ (anyOf 9)..tagstringRequired within parentMust equal: persistent_id_disabled
$ (anyOf 9).persistent_id_disabledstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 10)objectAlternative
$ (anyOf 10)..tagstringRequired within parentMust equal: user_creation_failed
$ (anyOf 10).user_creation_failedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 11)objectAlternative
$ (anyOf 11)..tagstringRequired within parentMust equal: success
$ (anyOf 11).profileModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile
$ (anyOf 11).roleModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — role

Referenced models: Updates a team member's profile — team members Set Profile — response body — role, Updates a team member's profile — team members Set Profile — response body — profile

Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete
$ (anyOf 3).completearrayRequired within parent
$ (anyOf 3).complete[]ModelEach itemExpand Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body — tag complete complete item
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedstringRequired within parent
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:in_progress|complete|failed)$)

Referenced models: Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body — tag complete complete item

Once an async job id is returned from members add:2 , use this to poll the status of the asynchronous request — response body — tag complete complete item

FieldTypePresenceDescription and constraints
$JSONRootDescribes 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.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: team_license_limit
$ (anyOf 1).team_license_limitstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: free_team_member_limit_reached
$ (anyOf 2).free_team_member_limit_reachedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: user_already_on_team
$ (anyOf 3).user_already_on_teamstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: user_on_another_team
$ (anyOf 4).user_on_another_teamstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: user_already_paired
$ (anyOf 5).user_already_pairedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: user_migration_failed
$ (anyOf 6).user_migration_failedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: duplicate_external_member_id
$ (anyOf 7).duplicate_external_member_idstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: duplicate_member_persistent_id
$ (anyOf 8).duplicate_member_persistent_idstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 9)objectAlternative
$ (anyOf 9)..tagstringRequired within parentMust equal: persistent_id_disabled
$ (anyOf 9).persistent_id_disabledstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 10)objectAlternative
$ (anyOf 10)..tagstringRequired within parentMust equal: user_creation_failed
$ (anyOf 10).user_creation_failedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 11)objectAlternative
$ (anyOf 11)..tagstringRequired within parentMust equal: success
$ (anyOf 11).profileModelRequired within parentExpand Updates a team member's profile — team members Set Profile — response body — profile
$ (anyOf 11).rolesJSONOptional
$ (anyOf 11).roles (anyOf 1)arrayAlternative
$ (anyOf 11).roles (anyOf 1)[]ModelEach itemExpand Get available Team Member Roles for the connected team — response body — roles item
$ (anyOf 11).roles (anyOf 2)nullAlternative
$ (anyOf 12)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 12)..tagstringRequired within parentPattern: ^(?!(?:team_license_limit|free_team_member_limit_reached|user_already_on_team|user_on_another_team|user_already_paired|user_migration_failed|duplicate_external_member_id|duplicate_member_persistent_id|persistent_id_disabled|user_creation_failed|success)$)

Referenced models: Updates a team member's profile — team members Set Profile — response body — profile, Get available Team Member Roles for the connected team — response body — roles item

Once an async job id is returned from members remove , use this to poll the status of the asynchronous request — response body

FieldTypePresenceDescription and constraints
$JSONRootResult returned by methods that poll for the status of an asynchronous job. Upon completion of the job, no additional information is returned.
$ (anyOf 1)stringAlternativeKnown values: in_progress, complete
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete

Permanently delete the files of a user who has been removed from the team — request body — body

FieldTypePresenceDescription and constraints
$objectRootExactly one of team_member_id, email, or external_id must be provided to identify a former team member.
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body

Referenced models: Sends welcome email to pending team member — request body — body

Permanently deletes an archived team folder — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$

Poll a previously launched member suspension batch job — response body

FieldTypePresenceDescription and constraints
$JSONRootCoarse job state. Live row progress and report contents are intentionally omitted; the authorized team admin who initiated the batch receives row details in the terminal email report.
$ (anyOf 1)stringAlternativeKnown values: in_progress
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: in_progress
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: complete
$ (anyOf 3).requestedJSONRequired within parent
$ (anyOf 3).requested (anyOf 1)integerAlternative
$ (anyOf 3).requested (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3).suspendedJSONRequired within parent
$ (anyOf 3).suspended (anyOf 1)integerAlternative
$ (anyOf 3).suspended (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3).failedJSONRequired within parent
$ (anyOf 3).failed (anyOf 1)integerAlternative
$ (anyOf 3).failed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3).unknownJSONRequired within parent
$ (anyOf 3).unknown (anyOf 1)integerAlternative
$ (anyOf 3).unknown (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3).report_deliveryModelRequired within parentExpand Poll a previously launched member suspension batch job — response body — tag complete report delivery
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: failed
$ (anyOf 4).failedModelRequired within parentExpand Poll a previously launched member suspension batch job — response body — tag failed failed
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:in_progress|complete|failed)$)

Referenced models: Poll a previously launched member suspension batch job — response body — tag complete report delivery, Poll a previously launched member suspension batch job — response body — tag failed failed

Poll a previously launched member suspension batch job — response body — tag complete report delivery

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: members_suspend_batch_report_delivery_status_unspecified, members_suspend_batch_report_delivery_status_pending, members_suspend_batch_report_delivery_status_delivered, members_suspend_batch_report_delivery_status_failed
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: members_suspend_batch_report_delivery_status_unspecified
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: members_suspend_batch_report_delivery_status_pending
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: members_suspend_batch_report_delivery_status_delivered
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: members_suspend_batch_report_delivery_status_failed
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:members_suspend_batch_report_delivery_status_unspecified|members_suspend_batch_report_delivery_status_pending|members_suspend_batch_report_delivery_status_delivered|members_suspend_batch_report_delivery_status_failed)$)

Poll a previously launched member suspension batch job — response body — tag failed failed

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: unusable_result
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: unusable_result
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:unusable_result)$)

Recover a deleted member — request body — body

FieldTypePresenceDescription and constraints
$objectRootExactly one of team_member_id, email, or external_id must be provided to identify the user account.
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body

Referenced models: Sends welcome email to pending team member — request body — body

Remove users custom quota — response body — item

FieldTypePresenceDescription and constraints
$JSONRootUser result for setting member custom quota.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).successModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_user
$ (anyOf 2).invalid_userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:success|invalid_user)$)

Referenced models: Sends welcome email to pending team member — request body — body

Removes a member from a team — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
wipe_databooleanOptional
transfer_dest_idJSONOptional
transfer_dest_id (anyOf 1)ModelAlternativeExpand Sends welcome email to pending team member — request body — body
transfer_dest_id (anyOf 2)nullAlternative
transfer_admin_idJSONOptional
transfer_admin_id (anyOf 1)ModelAlternativeExpand Sends welcome email to pending team member — request body — body
transfer_admin_id (anyOf 2)nullAlternative
keep_accountbooleanOptional
retain_team_sharesbooleanOptional
permanently_delete_filesbooleanOptional

Referenced models: Sends welcome email to pending team member — request body — body

Removes members from a group — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
return_membersbooleanOptional
groupModelRequired within parentExpand Deletes a group — request body — body
usersarrayRequired within parent
users[]ModelEach itemExpand Sends welcome email to pending team member — request body — body

Referenced models: Sends welcome email to pending team member — request body — body, Deletes a group — request body — body

Removes members from a group — response body

FieldTypePresenceDescription and constraints
$objectRootResult returned by groups/members/add and groups/members/remove.
group_infoModelRequired within parentExpand Updates a group's name and or external ID — response body
async_job_idstringRequired within parentMinimum length: 1

Referenced models: Updates a group's name and or external ID — response body

Resend secondary email verification emails — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
emails_to_resendarrayRequired within parent
emails_to_resend[]ModelEach itemExpand Resend secondary email verification emails — request body — body emails to resend item

Referenced models: Resend secondary email verification emails — request body — body emails to resend item

Resend secondary email verification emails — request body — body emails to resend item

FieldTypePresenceDescription and constraints
$objectRootUser and a list of secondary emails.
userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
secondary_emailsarrayRequired within parent
secondary_emails[]stringEach itemMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$

Referenced models: Sends welcome email to pending team member — request body — body

Resend secondary email verification emails — response body

FieldTypePresenceDescription and constraints
$objectRootList of users and resend results.
resultsarrayRequired within parent
results[]ModelEach itemExpand Resend secondary email verification emails — response body — results item

Referenced models: Resend secondary email verification emails — response body — results item

Resend secondary email verification emails — response body — results item

FieldTypePresenceDescription and constraints
$JSONRootResult of trying to resend verification emails to a user. 'success' is the only value indicating that a user was successfully retrieved for sending verification emails. The other values explain the type of error that occurred, and include the user for which the error occurred.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 1).resultsarrayRequired within parent
$ (anyOf 1).results[]ModelEach itemExpand Resend secondary email verification emails — response body — results item tag success results item
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: invalid_user
$ (anyOf 2).invalid_userModelRequired within parentExpand Sends welcome email to pending team member — request body — body
$ (anyOf 3)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 3)..tagstringRequired within parentPattern: ^(?!(?:success|invalid_user)$)

Referenced models: Resend secondary email verification emails — response body — results item tag success results item, Sends welcome email to pending team member — request body — body

Resend secondary email verification emails — response body — results item tag success results item

FieldTypePresenceDescription and constraints
$JSONRootResult of trying to resend verification email to a secondary email address. 'success' is the only value indicating that a verification email was successfully sent. The other values explain the type of error that occurred, and include the email for which the error occurred.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: success
$ (anyOf 1).successstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: not_pending
$ (anyOf 2).not_pendingstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: rate_limited
$ (anyOf 3).rate_limitedstringRequired within parentMaximum length: 255
Pattern: ^(?:^['#&A-Za-z0-9._%+-]+@[A-Za-z0-9-][A-Za-z0-9.-]*\.[A-Za-z]{2,15}$)$
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:success|not_pending|rate_limited)$)

Retrieves information about a team — response body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parent
team_idstringRequired within parent
num_licensed_usersJSONRequired within parent
num_licensed_users (anyOf 1)integerAlternativeMinimum: 0
num_licensed_users (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_provisioned_usersJSONRequired within parent
num_provisioned_users (anyOf 1)integerAlternativeMinimum: 0
num_provisioned_users (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
num_used_licensesJSONOptional
num_used_licenses (anyOf 1)integerAlternativeMinimum: 0
num_used_licenses (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
policiesModelRequired within parentExpand Retrieves information about a team — response body — policies

Referenced models: Retrieves information about a team — response body — policies

Retrieves information about a team — response body — policies

FieldTypePresenceDescription and constraints
$objectRootPolicies governing team members.
sharingModelRequired within parentExpand Retrieves information about a team — response body — policies sharing
emm_stateModelRequired within parentExpand Retrieves information about a team — response body — policies emm state
office_addinModelRequired within parentExpand Retrieves information about a team — response body — policies office addin
suggest_members_policyModelRequired within parentExpand Retrieves information about a team — response body — policies office addin
top_level_content_policyModelRequired within parentExpand Retrieves information about a team — response body — policies top level content policy

Referenced models: Retrieves information about a team — response body — policies office addin, Retrieves information about a team — response body — policies emm state, Retrieves information about a team — response body — policies sharing, Retrieves information about a team — response body — policies top level content policy

Retrieves information about a team — response body — policies emm state

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: disabled, optional, required
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: disabled
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: optional
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: required
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:disabled|optional|required)$)

Retrieves information about a team — response body — policies office addin

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: disabled, enabled
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: disabled
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: enabled
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:disabled|enabled)$)

Retrieves information about a team — response body — policies sharing

FieldTypePresenceDescription and constraints
$objectRootPolicies governing sharing within and outside of the team.
shared_folder_member_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing shared folder member policy
shared_folder_join_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing shared folder join policy
shared_link_create_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing shared link create policy
group_creation_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing group creation policy
shared_folder_link_restriction_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing shared folder link restriction policy
enforce_link_password_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing enforce link password policy
default_link_expiration_days_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing default link expiration days policy
shared_link_default_permissions_policyModelRequired within parentExpand Retrieves information about a team — response body — policies sharing shared link default permissions policy

Referenced models: Retrieves information about a team — response body — policies sharing default link expiration days policy, Retrieves information about a team — response body — policies sharing enforce link password policy, Retrieves information about a team — response body — policies sharing group creation policy, Retrieves information about a team — response body — policies sharing shared folder link restriction policy, Retrieves information about a team — response body — policies sharing shared folder join policy, Retrieves information about a team — response body — policies sharing shared folder member policy, Retrieves information about a team — response body — policies sharing shared link create policy, Retrieves information about a team — response body — policies sharing shared link default permissions policy

Retrieves information about a team — response body — policies sharing default link expiration days policy

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing default expiration date for new links shared outside the team.
$ (anyOf 1)stringAlternativeKnown values: none, day_1, day_3, day_7, day_30, day_90, day_180, year_1
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: none
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: day_1
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: day_3
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: day_7
$ (anyOf 6)objectAlternative
$ (anyOf 6)..tagstringRequired within parentMust equal: day_30
$ (anyOf 7)objectAlternative
$ (anyOf 7)..tagstringRequired within parentMust equal: day_90
$ (anyOf 8)objectAlternative
$ (anyOf 8)..tagstringRequired within parentMust equal: day_180
$ (anyOf 9)objectAlternative
$ (anyOf 9)..tagstringRequired within parentMust equal: year_1
$ (anyOf 10)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 10)..tagstringRequired within parentPattern: ^(?!(?:none|day_1|day_3|day_7|day_30|day_90|day_180|year_1)$)

Retrieves information about a team — response body — policies sharing enforce link password policy

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing whether new links shared outside the team require passwords.
$ (anyOf 1)stringAlternativeKnown values: optional, required
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: optional
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: required
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:optional|required)$)

Retrieves information about a team — response body — policies sharing group creation policy

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: admins_and_members, admins_only
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: admins_and_members
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: admins_only

Retrieves information about a team — response body — policies sharing shared folder join policy

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing which shared folders a team member can join.
$ (anyOf 1)stringAlternativeKnown values: from_team_only, from_anyone
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: from_team_only
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: from_anyone
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:from_team_only|from_anyone)$)

Retrieves information about a team — response body — policies sharing shared folder link restriction policy

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing whether shared folder membership is required to access shared links.
$ (anyOf 1)stringAlternativeKnown values: members, anyone
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: members
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: anyone
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:members|anyone)$)

Retrieves information about a team — response body — policies sharing shared folder member policy

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing who can be a member of a folder shared by a team member.
$ (anyOf 1)stringAlternativeKnown values: team, anyone, team_and_approved
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: team
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: anyone
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: team_and_approved
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:team|anyone|team_and_approved)$)

Retrieves information about a team — response body — policies sharing shared link create policy

FieldTypePresenceDescription and constraints
$JSONRootPolicy governing the visibility of shared links. This policy can apply to newly created shared links, or all shared links.
$ (anyOf 1)stringAlternativeKnown values: default_public, default_team_only, team_only, default_no_one
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: default_public
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: default_team_only
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: team_only
$ (anyOf 5)objectAlternative
$ (anyOf 5)..tagstringRequired within parentMust equal: default_no_one
$ (anyOf 6)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tagstringRequired within parentPattern: ^(?!(?:default_public|default_team_only|team_only|default_no_one)$)

Retrieves information about a team — response body — policies sharing shared link default permissions policy

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: default, edit, view
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: default
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: edit
$ (anyOf 4)objectAlternative
$ (anyOf 4)..tagstringRequired within parentMust equal: view
$ (anyOf 5)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 5)..tagstringRequired within parentPattern: ^(?!(?:default|edit|view)$)

Retrieves information about a team — response body — policies top level content policy

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeKnown values: admin_only, everyone
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: admin_only
$ (anyOf 3)objectAlternative
$ (anyOf 3)..tagstringRequired within parentMust equal: everyone
$ (anyOf 4)objectAlternativeA tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tagstringRequired within parentPattern: ^(?!(?:admin_only|everyone)$)

Retrieves information about one or more groups — request body — body

FieldTypePresenceDescription and constraints
$JSONRootArgument for selecting a list of groups, either by group_ids, or external group IDs.
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: group_ids
$ (anyOf 1).group_idsarrayRequired within parent
$ (anyOf 1).group_ids[]stringEach item
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: group_external_ids
$ (anyOf 2).group_external_idsarrayRequired within parent
$ (anyOf 2).group_external_ids[]stringEach item

Retrieves information about one or more groups — response body

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand Retrieves information about one or more groups — response body — item

Referenced models: Retrieves information about one or more groups — response body — item

Retrieves information about one or more groups — response body — item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: id_not_found
$ (anyOf 1).id_not_foundstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: group_info
$ (anyOf 2).group_namestringRequired within parent
$ (anyOf 2).group_idstringRequired within parent
$ (anyOf 2).group_external_idJSONOptional
$ (anyOf 2).group_external_id (anyOf 1)stringAlternative
$ (anyOf 2).group_external_id (anyOf 2)nullAlternative
$ (anyOf 2).member_countJSONOptional
$ (anyOf 2).member_count (anyOf 1)JSONAlternative
$ (anyOf 2).member_count (anyOf 1) (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).member_count (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2).member_count (anyOf 2)nullAlternative
$ (anyOf 2).group_management_typeModelRequired within parentExpand Updates a group's name and or external ID — response body — group management type
$ (anyOf 2).membersJSONOptional
$ (anyOf 2).members (anyOf 1)arrayAlternative
$ (anyOf 2).members (anyOf 1)[]ModelEach itemExpand Lists members of a group — response body — members item
$ (anyOf 2).members (anyOf 2)nullAlternative
$ (anyOf 2).createdJSONRequired within parent
$ (anyOf 2).created (anyOf 1)integerAlternativeMinimum: 0
$ (anyOf 2).created (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Updates a group's name and or external ID — response body — group management type, Lists members of a group — response body — members item

Retrieves metadata for team folders — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
team_folder_idsarrayRequired within parentMinimum items: 1
team_folder_ids[]stringEach itemPattern: ^(?:[-_0-9a-zA-Z:]+)$

Retrieves metadata for team folders — response body — item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternative
$ (anyOf 1)..tagstringRequired within parentMust equal: id_not_found
$ (anyOf 1).id_not_foundstringRequired within parent
$ (anyOf 2)objectAlternative
$ (anyOf 2)..tagstringRequired within parentMust equal: team_folder_metadata
$ (anyOf 2).team_folder_idstringRequired within parentPattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 2).namestringRequired within parent
$ (anyOf 2).statusModelRequired within parentExpand Changes an active team folder's name — response body — status
$ (anyOf 2).is_team_shared_dropboxbooleanRequired within parent
$ (anyOf 2).sync_settingModelRequired within parentExpand Changes an active team folder's name — response body — sync setting
$ (anyOf 2).content_sync_settingsarrayRequired within parent
$ (anyOf 2).content_sync_settings[]ModelEach itemExpand Changes an active team folder's name — response body — content sync settings item
$ (anyOf 2).quota_limitJSONOptional
$ (anyOf 2).quota_limit (anyOf 1)integerAlternative
$ (anyOf 2).quota_limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Changes an active team folder's name — response body — content sync settings item, Changes an active team folder's name — response body — sync setting, Changes an active team folder's name — response body — status

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.