Dropbox: Users schemas

20 Dropbox schemas with complete fields and constraints.

Get a list of feature values that may be configured for the current account — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`features`	array	Required within parent
`features[]`	Model	Each item	Expand Get a list of feature values that may be configured for the current account — request body — body features item

Referenced models: Get a list of feature values that may be configured for the current account — request body — body features item

Get a list of feature values that may be configured for the current account — request body — body features item

Field	Type	Presence	Description and constraints
`$`	JSON	Root	A set of features that a Dropbox User account may have configured.
`$ (anyOf 1)`	string	Alternative	One of: paper_as_files, file_locking, team_shared_dropbox, distinct_member_home
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: paper_as_files
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: file_locking
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: team_shared_dropbox
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: distinct_member_home
`$ (anyOf 6)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 6)..tag`	string	Required within parent	Pattern: ^(?!(?:paper_as_files\|file_locking\|team_shared_dropbox\|distinct_member_home)$)

Get a list of feature values that may be configured for the current account — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`values`	array	Required within parent
`values[]`	Model	Each item	Expand Get a list of feature values that may be configured for the current account — response body — values item

Referenced models: Get a list of feature values that may be configured for the current account — response body — values item

Get a list of feature values that may be configured for the current account — response body — values item

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Values that correspond to entries in UserFeature.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: paper_as_files
`$ (anyOf 1).paper_as_files`	Model	Required within parent	Expand Get a list of feature values that may be configured for the current account — response body — values item tag paper as files paper as files
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: file_locking
`$ (anyOf 2).file_locking`	Model	Required within parent	Expand Get a list of feature values that may be configured for the current account — response body — values item tag file locking file locking
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: team_shared_dropbox
`$ (anyOf 3).team_shared_dropbox`	Model	Required within parent	Expand Get a list of feature values that may be configured for the current account — response body — values item tag team shared dropbox team shared dropbox
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: distinct_member_home
`$ (anyOf 4).distinct_member_home`	Model	Required within parent	Expand Get a list of feature values that may be configured for the current account — response body — values item tag distinct member home distinct member home
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:paper_as_files\|file_locking\|team_shared_dropbox\|distinct_member_home)$)

Referenced models: Get a list of feature values that may be configured for the current account — response body — values item tag distinct member home distinct member home, Get a list of feature values that may be configured for the current account — response body — values item tag file locking file locking, Get a list of feature values that may be configured for the current account — response body — values item tag paper as files paper as files, Get a list of feature values that may be configured for the current account — response body — values item tag team shared dropbox team shared dropbox

Get a list of feature values that may be configured for the current account — response body — values item tag distinct member home distinct member home

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The value for UserFeature.distinct_member_home.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: enabled
`$ (anyOf 1).enabled`	boolean	Required within parent
`$ (anyOf 2)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 2)..tag`	string	Required within parent	Pattern: ^(?!(?:enabled)$)

Get a list of feature values that may be configured for the current account — response body — values item tag file locking file locking

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The value for UserFeature.file_locking.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: enabled
`$ (anyOf 1).enabled`	boolean	Required within parent
`$ (anyOf 2)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 2)..tag`	string	Required within parent	Pattern: ^(?!(?:enabled)$)

Get a list of feature values that may be configured for the current account — response body — values item tag paper as files paper as files

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The value for UserFeature.paper_as_files.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: enabled
`$ (anyOf 1).enabled`	boolean	Required within parent
`$ (anyOf 2)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 2)..tag`	string	Required within parent	Pattern: ^(?!(?:enabled)$)

Get a list of feature values that may be configured for the current account — response body — values item tag team shared dropbox team shared dropbox

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The value for UserFeature.team_shared_dropbox.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: enabled
`$ (anyOf 1).enabled`	boolean	Required within parent
`$ (anyOf 2)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 2)..tag`	string	Required within parent	Pattern: ^(?!(?:enabled)$)

Get information about a user's account — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`account_id`	string	Required within parent	Maximum length: 40 Minimum length: 40

Get information about a user's account — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Basic information about any account.
`account_id`	string	Required within parent	Maximum length: 40 Minimum length: 40
`name`	Model	Required within parent	Expand Get information about a user's account — response body — name
`email`	string	Required within parent
`email_verified`	boolean	Required within parent
`profile_photo_url`	JSON	Optional
`profile_photo_url (anyOf 1)`	string	Alternative
`profile_photo_url (anyOf 2)`	null	Alternative
`disabled`	boolean	Required within parent
`is_teammate`	boolean	Required within parent
`team_member_id`	JSON	Optional
`team_member_id (anyOf 1)`	string	Alternative
`team_member_id (anyOf 2)`	null	Alternative

Referenced models: Get information about a user's account — response body — name

Get information about a user's account — response body — name

Field	Type	Presence	Description and constraints
`$`	object	Root	Representations for a person's name to assist with internationalization.
`given_name`	string	Required within parent
`surname`	string	Required within parent
`familiar_name`	string	Required within parent
`display_name`	string	Required within parent
`abbreviated_name`	string	Required within parent

Get information about multiple user accounts — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`account_ids`	array	Required within parent	Minimum items: 1
`account_ids[]`	string	Each item	Maximum length: 40 Minimum length: 40

Get information about multiple user accounts — response body

Field	Type	Presence	Description and constraints
`$`	array	Root
`$[]`	Model	Each item	Expand Get information about a user's account — response body

Referenced models: Get information about a user's account — response body

Get information about the current user's account — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Detailed information about the current user's account.
`account_id`	string	Required within parent	Maximum length: 40 Minimum length: 40
`name`	Model	Required within parent	Expand Get information about a user's account — response body — name
`email`	string	Required within parent
`email_verified`	boolean	Required within parent
`profile_photo_url`	JSON	Optional
`profile_photo_url (anyOf 1)`	string	Alternative
`profile_photo_url (anyOf 2)`	null	Alternative
`disabled`	boolean	Required within parent
`country`	JSON	Optional
`country (anyOf 1)`	string	Alternative	Maximum length: 2 Minimum length: 2
`country (anyOf 2)`	null	Alternative
`locale`	string	Required within parent	Minimum length: 2
`referral_link`	string	Required within parent
`team`	JSON	Optional
`team (anyOf 1)`	Model	Alternative	Expand Get information about the current user's account — response body — team Detailed information about a team
`team (anyOf 2)`	null	Alternative
`team_member_id`	JSON	Optional
`team_member_id (anyOf 1)`	string	Alternative
`team_member_id (anyOf 2)`	null	Alternative
`is_paired`	boolean	Required within parent
`account_type`	Model	Required within parent	Expand Get information about the current user's account — response body — account type
`root_info`	Model	Required within parent	Expand Get information about the current user's account — response body — root info

Referenced models: Get information about the current user's account — response body — root info, Get information about the current user's account — response body — account type, Get information about the current user's account — response body — team Detailed information about a team, Get information about a user's account — response body — name

Get information about the current user's account — response body — account type

Field	Type	Presence	Description and constraints
`$`	JSON	Root	What type of account this user has.
`$ (anyOf 1)`	string	Alternative	Known values: basic, pro, business
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: basic
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: pro
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: business

Get information about the current user's account — response body — root info

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Information about current user's root.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: team
`$ (anyOf 1).root_namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 1).home_namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 1).home_path`	string	Required within parent
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: user
`$ (anyOf 2).root_namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 2).home_namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 2).home_path`	JSON	Optional
`$ (anyOf 2).home_path (anyOf 1)`	string	Alternative
`$ (anyOf 2).home_path (anyOf 2)`	null	Alternative
`$ (anyOf 3)`	object	Alternative	Information about current user's root.
`$ (anyOf 3).root_namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 3).home_namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 3)..tag`	string	Optional	Pattern: ^(?!(?:team\|user)$)

Get information about the current user's account — response body — team Detailed information about a team

Field	Type	Presence	Description and constraints
`$`	object	Root	Detailed information about a team.
`id`	string	Required within parent
`name`	string	Required within parent
`sharing_policies`	Model	Required within parent	Expand Retrieves information about a team — response body — policies sharing
`office_addin_policy`	Model	Required within parent	Expand Retrieves information about a team — response body — policies office addin
`top_level_content_policy`	Model	Required within parent	Expand 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 sharing, Retrieves information about a team — response body — policies top level content policy

Get the space usage information for the current user's account — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about a user's space usage and quota.
`used`	JSON	Required within parent
`used (anyOf 1)`	integer	Alternative	Minimum: 0
`used (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`allocation`	Model	Required within parent	Expand Get the space usage information for the current user's account — response body — allocation

Referenced models: Get the space usage information for the current user's account — response body — allocation

Get the space usage information for the current user's account — response body — allocation

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Space is allocated differently based on the type of account.
`$ (anyOf 1)`	object	Alternative
`$ (anyOf 1)..tag`	string	Required within parent	Must equal: individual
`$ (anyOf 1).allocated`	JSON	Required within parent
`$ (anyOf 1).allocated (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 1).allocated (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: team
`$ (anyOf 2).used`	JSON	Required within parent
`$ (anyOf 2).used (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 2).used (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2).allocated`	JSON	Required within parent
`$ (anyOf 2).allocated (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 2).allocated (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2).user_within_team_space_allocated`	JSON	Required within parent
`$ (anyOf 2).user_within_team_space_allocated (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 2).user_within_team_space_allocated (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 2).user_within_team_space_limit_type`	Model	Required within parent	Expand Get the space usage information for the current user's account — response body — allocation tag team user within team space limit type
`$ (anyOf 2).user_within_team_space_used_cached`	JSON	Required within parent
`$ (anyOf 2).user_within_team_space_used_cached (anyOf 1)`	integer	Alternative	Minimum: 0
`$ (anyOf 2).user_within_team_space_used_cached (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 3)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 3)..tag`	string	Required within parent	Pattern: ^(?!(?:individual\|team)$)

Referenced models: Get the space usage information for the current user's account — response body — allocation tag team user within team space limit type

Get the space usage information for the current user's account — response body — allocation tag team user within team space limit type

Field	Type	Presence	Description and constraints
`$`	JSON	Root	The type of the space limit imposed on a team member.
`$ (anyOf 1)`	string	Alternative	Known values: off, alert_only, stop_sync
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: off
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: alert_only
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: stop_sync
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:off\|alert_only\|stop_sync)$)

Report an issue with this page