Dropbox: Files schemas (part 2)

← Files operations · All schemas

Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path order by value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: relevance, last_modified_time
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: relevance
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: last_modified_time
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:relevance|last_modified_time)$)

Searches for files and folders — response body

Field	Type	Presence	Description and constraints
$	object	Root
matches	array	Required within parent
matches[]	Model	Each item	Expand Searches for files and folders — response body — matches item
has_more	boolean	Required within parent
cursor	JSON	Optional
cursor (anyOf 1)	string	Alternative	Minimum length: 1
cursor (anyOf 2)	null	Alternative

Referenced models: Searches for files and folders — response body — matches item

Searches for files and folders — response body — matches item

Field	Type	Presence	Description and constraints
$	object	Root
metadata	Model	Required within parent	Expand Searches for files and folders — response body — matches item metadata
match_type	JSON	Optional
match_type (anyOf 1)	Model	Alternative	Expand Searches for files and folders — response body — matches item match type value
match_type (anyOf 2)	null	Alternative
highlight_spans	JSON	Optional
highlight_spans (anyOf 1)	array	Alternative
highlight_spans (anyOf 1)[]	Model	Each item	Expand Searches for files and folders — response body — matches item highlight spans array item
highlight_spans (anyOf 2)	null	Alternative

Referenced models: Searches for files and folders — response body — matches item highlight spans array item, Searches for files and folders — response body — matches item metadata, Searches for files and folders — response body — matches item match type value

Searches for files and folders — response body — matches item highlight spans array item

Field	Type	Presence	Description and constraints
$	object	Root
highlight_str	string	Required within parent
is_highlighted	boolean	Required within parent

Searches for files and folders — response body — matches item match type value

Field	Type	Presence	Description and constraints
$	JSON	Root	Indicates what type of match was found for a given item.
$ (anyOf 1)	string	Alternative	Known values: filename, file_content, filename_and_content, image_content, metadata
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: filename
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: file_content
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: filename_and_content
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: image_content
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: metadata
$ (anyOf 7)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tag	string	Required within parent	Pattern: ^(?!(?:filename|file_content|filename_and_content|image_content|metadata)$)

Searches for files and folders — response body — matches item metadata

Field	Type	Presence	Description and constraints
$	JSON	Root	Metadata for a file, folder or other resource types.
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: metadata
$ (anyOf 1).metadata	Model	Required within parent	Expand Returns the metadata for a file or folder — response body
$ (anyOf 2)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 2)..tag	string	Required within parent	Pattern: ^(?!(?:metadata)$)

Referenced models: Returns the metadata for a file or folder — response body

Start a batch of upload sessions — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
session_type	JSON	Optional
session_type (anyOf 1)	Model	Alternative	Expand Start a batch of upload sessions — request body — body session type value
session_type (anyOf 2)	null	Alternative
num_sessions	integer	Required within parent	Minimum: 1 Maximum: 1000

Referenced models: Start a batch of upload sessions — request body — body session type value

Start a batch of upload sessions — request body — body session type value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: sequential, concurrent
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: sequential
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: concurrent
$ (anyOf 4)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 4)..tag	string	Required within parent	Pattern: ^(?!(?:sequential|concurrent)$)

Start a batch of upload sessions — response body

Field	Type	Presence	Description and constraints
$	object	Root
session_ids	array	Required within parent
session_ids[]	string	Each item

Starts returning the contents of a folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
path	string	Required within parent	Pattern: ^(?:(/(.|[\r\n])*)?|id:.*|(ns:[0-9]+(/(.|[\r\n])*)?))$
recursive	boolean	Optional
include_media_info	boolean	Optional
include_deleted	boolean	Optional
include_has_explicit_shared_members	boolean	Optional
include_mounted_folders	boolean	Optional
limit	JSON	Optional
limit (anyOf 1)	integer	Alternative	Minimum: 1 Maximum: 2000
limit (anyOf 2)	null	Alternative
shared_link	JSON	Optional
shared_link (anyOf 1)	Model	Alternative	Expand Starts returning the contents of a folder — request body — body shared link password, url
shared_link (anyOf 2)	null	Alternative
include_property_groups	JSON	Optional
include_property_groups (anyOf 1)	Model	Alternative	Expand Returns the metadata for a file or folder — request body — body include property groups value
include_property_groups (anyOf 2)	null	Alternative
include_non_downloadable_files	boolean	Optional
include_restorable_info	boolean	Optional

Referenced models: Returns the metadata for a file or folder — request body — body include property groups value, Starts returning the contents of a folder — request body — body shared link password, url

Starts returning the contents of a folder — request body — body shared link password, url

Field	Type	Presence	Description and constraints
$	object	Root
url	string	Required within parent
password	JSON	Optional
password (anyOf 1)	string	Alternative
password (anyOf 2)	null	Alternative

Starts returning the contents of a folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
entries	array	Required within parent
entries[]	Model	Each item	Expand Returns the metadata for a file or folder — response body
cursor	string	Required within parent	Minimum length: 1
has_more	boolean	Required within parent

Referenced models: Returns the metadata for a file or folder — response body

This route helps you commit many files at once into a user's Dropbox — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
entries	array	Required within parent	Maximum items: 1000
entries[]	Model	Each item	Expand Finish an upload session and save the uploaded data to the given file path — request body — headers Dropbox-API-Arg

Referenced models: Finish an upload session and save the uploaded data to the given file path — request body — headers Dropbox-API-Arg

This route helps you commit many files at once into a user's Dropbox — response body

Field	Type	Presence	Description and constraints
$	object	Root
entries	array	Required within parent
entries[]	Model	Each item	Expand This route helps you commit many files at once into a user's Dropbox — response body — entries item

Referenced models: This route helps you commit many files at once into a user's Dropbox — response body — entries item

This route helps you commit many files at once into a user's Dropbox — response body — entries item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative
$ (anyOf 1)..tag	string	Required within parent	Must equal: success
$ (anyOf 1).name	string	Required within parent
$ (anyOf 1).path_lower	JSON	Optional
$ (anyOf 1).path_lower (anyOf 1)	string	Alternative
$ (anyOf 1).path_lower (anyOf 2)	null	Alternative
$ (anyOf 1).path_display	JSON	Optional
$ (anyOf 1).path_display (anyOf 1)	string	Alternative
$ (anyOf 1).path_display (anyOf 2)	null	Alternative
$ (anyOf 1).parent_shared_folder_id	JSON	Optional
$ (anyOf 1).parent_shared_folder_id (anyOf 1)	string	Alternative	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
$ (anyOf 1).parent_shared_folder_id (anyOf 2)	null	Alternative
$ (anyOf 1).preview_url	JSON	Optional
$ (anyOf 1).preview_url (anyOf 1)	string	Alternative
$ (anyOf 1).preview_url (anyOf 2)	null	Alternative
$ (anyOf 1).id	string	Required within parent	Minimum length: 1
$ (anyOf 1).client_modified	string	Required within parent
$ (anyOf 1).server_modified	string	Required within parent
$ (anyOf 1).rev	string	Required within parent	Minimum length: 9 Pattern: ^(?:[0-9a-f]+)$
$ (anyOf 1).size	JSON	Required within parent
$ (anyOf 1).size (anyOf 1)	integer	Alternative	Minimum: 0
$ (anyOf 1).size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).media_info	JSON	Optional
$ (anyOf 1).media_info (anyOf 1)	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — media info value
$ (anyOf 1).media_info (anyOf 2)	null	Alternative
$ (anyOf 1).symlink_info	JSON	Optional
$ (anyOf 1).symlink_info (anyOf 1)	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — symlink info target
$ (anyOf 1).symlink_info (anyOf 2)	null	Alternative
$ (anyOf 1).sharing_info	JSON	Optional
$ (anyOf 1).sharing_info (anyOf 1)	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only
$ (anyOf 1).sharing_info (anyOf 2)	null	Alternative
$ (anyOf 1).is_downloadable	boolean	Optional
$ (anyOf 1).export_info	JSON	Optional
$ (anyOf 1).export_info (anyOf 1)	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — export info Export information for a file
$ (anyOf 1).export_info (anyOf 2)	null	Alternative
$ (anyOf 1).property_groups	JSON	Optional
$ (anyOf 1).property_groups (anyOf 1)	array	Alternative
$ (anyOf 1).property_groups (anyOf 1)[]	Model	Each item	Expand Add property groups to a Dropbox file — request body — body property groups item
$ (anyOf 1).property_groups (anyOf 2)	null	Alternative
$ (anyOf 1).has_explicit_shared_members	JSON	Optional
$ (anyOf 1).has_explicit_shared_members (anyOf 1)	boolean	Alternative
$ (anyOf 1).has_explicit_shared_members (anyOf 2)	null	Alternative
$ (anyOf 1).content_hash	JSON	Optional
$ (anyOf 1).content_hash (anyOf 1)	string	Alternative	Maximum length: 64 Minimum length: 64
$ (anyOf 1).content_hash (anyOf 2)	null	Alternative
$ (anyOf 1).file_lock_info	JSON	Optional
$ (anyOf 1).file_lock_info (anyOf 1)	Model	Alternative	Expand Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name
$ (anyOf 1).file_lock_info (anyOf 2)	null	Alternative
$ (anyOf 1).is_restorable	JSON	Optional
$ (anyOf 1).is_restorable (anyOf 1)	boolean	Alternative
$ (anyOf 1).is_restorable (anyOf 2)	null	Alternative
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: failure
$ (anyOf 2).failure	Model	Required within parent	Expand This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure

Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Restore a specific revision of a file to the given path — response body — export info Export information for a file, Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name, Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only, Restore a specific revision of a file to the given path — response body — symlink info target, Restore a specific revision of a file to the given path — response body — media info value, This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure

This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: too_many_shared_folder_targets, too_many_write_operations, concurrent_session_data_not_allowed, concurrent_session_not_closed, concurrent_session_missing_data, payload_too_large, content_hash_mismatch, encryption_not_supported
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: lookup_failed
$ (anyOf 2).lookup_failed	Model	Required within parent	Expand This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag lookup failed lookup failed
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: path
$ (anyOf 3).path	Model	Required within parent	Expand Check the status of a save url job — response body — tag failed failed tag path path
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: properties_error
$ (anyOf 4).properties_error	Model	Required within parent	Expand This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag properties error properties error
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: too_many_shared_folder_targets
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: too_many_write_operations
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: concurrent_session_data_not_allowed
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: concurrent_session_not_closed
$ (anyOf 9)	object	Alternative
$ (anyOf 9)..tag	string	Required within parent	Must equal: concurrent_session_missing_data
$ (anyOf 10)	object	Alternative
$ (anyOf 10)..tag	string	Required within parent	Must equal: payload_too_large
$ (anyOf 11)	object	Alternative
$ (anyOf 11)..tag	string	Required within parent	Must equal: content_hash_mismatch
$ (anyOf 12)	object	Alternative
$ (anyOf 12)..tag	string	Required within parent	Must equal: encryption_not_supported
$ (anyOf 13)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 13)..tag	string	Required within parent	Pattern: ^(?!(?:lookup_failed|path|properties_error|too_many_shared_folder_targets|too_many_write_operations|concurrent_session_data_not_allowed|concurrent_session_not_closed|concurrent_session_missing_data|payload_too_large|content_hash_mismatch|encryption_not_supported)$)

Referenced models: This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag properties error properties error, This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag lookup failed lookup failed, Check the status of a save url job — response body — tag failed failed tag path path

This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag lookup failed lookup failed

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: not_found, closed, not_closed, too_large, concurrent_session_invalid_offset, concurrent_session_invalid_data_size, payload_too_large
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: not_found
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: incorrect_offset
$ (anyOf 3).correct_offset	JSON	Required within parent
$ (anyOf 3).correct_offset (anyOf 1)	integer	Alternative	Minimum: 0
$ (anyOf 3).correct_offset (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: closed
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: not_closed
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: too_large
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: concurrent_session_invalid_offset
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: concurrent_session_invalid_data_size
$ (anyOf 9)	object	Alternative
$ (anyOf 9)..tag	string	Required within parent	Must equal: payload_too_large
$ (anyOf 10)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 10)..tag	string	Required within parent	Pattern: ^(?!(?:not_found|incorrect_offset|closed|not_closed|too_large|concurrent_session_invalid_offset|concurrent_session_invalid_data_size|payload_too_large)$)

This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag properties error properties error

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: restricted_content, unsupported_folder, property_field_too_large, does_not_fit_template, duplicate_property_groups
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: template_not_found
$ (anyOf 2).template_not_found	string	Required within parent	Minimum length: 1 Pattern: ^(?:(/|ptid:).*)$
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: restricted_content
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: path
$ (anyOf 4).path	Model	Required within parent	Expand This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag properties error properties error tag path path
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: unsupported_folder
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: property_field_too_large
$ (anyOf 7)	object	Alternative
$ (anyOf 7)..tag	string	Required within parent	Must equal: does_not_fit_template
$ (anyOf 8)	object	Alternative
$ (anyOf 8)..tag	string	Required within parent	Must equal: duplicate_property_groups
$ (anyOf 9)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 9)..tag	string	Required within parent	Pattern: ^(?!(?:template_not_found|restricted_content|path|unsupported_folder|property_field_too_large|does_not_fit_template|duplicate_property_groups)$)

Referenced models: This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag properties error properties error tag path path

This route helps you commit many files at once into a user's Dropbox — response body — entries item tag failure failure tag properties error properties error tag path path

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Known values: not_found, not_file, not_folder, restricted_content
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: malformed_path
$ (anyOf 2).malformed_path	string	Required within parent
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: not_found
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: not_file
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: not_folder
$ (anyOf 6)	object	Alternative
$ (anyOf 6)..tag	string	Required within parent	Must equal: restricted_content
$ (anyOf 7)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 7)..tag	string	Required within parent	Pattern: ^(?!(?:malformed_path|not_found|not_file|not_folder|restricted_content)$)

Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg

Field	Type	Presence	Description and constraints
$	object	Root
path	string	Required within parent	Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$
import_format	Model	Required within parent	Expand Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format
doc_update_policy	Model	Required within parent	Expand Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg doc update policy
paper_revision	JSON	Optional
paper_revision (anyOf 1)	integer	Alternative
paper_revision (anyOf 2)	null	Alternative

Referenced models: Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format, Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg doc update policy

Updates an existing Paper doc with the provided content — request body — headers Dropbox-API-Arg doc update policy

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	One of: update, overwrite, prepend, append
$ (anyOf 2)	object	Alternative
$ (anyOf 2)..tag	string	Required within parent	Must equal: update
$ (anyOf 3)	object	Alternative
$ (anyOf 3)..tag	string	Required within parent	Must equal: overwrite
$ (anyOf 4)	object	Alternative
$ (anyOf 4)..tag	string	Required within parent	Must equal: prepend
$ (anyOf 5)	object	Alternative
$ (anyOf 5)..tag	string	Required within parent	Must equal: append
$ (anyOf 6)	object	Alternative	A tag this contract version does not list (Dropbox's other).
$ (anyOf 6)..tag	string	Required within parent	Pattern: ^(?!(?:update|overwrite|prepend|append)$)

Updates an existing Paper doc with the provided content — response body

Field	Type	Presence	Description and constraints
$	object	Root
paper_revision	JSON	Required within parent
paper_revision (anyOf 1)	integer	Alternative
paper_revision (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 Mi B — request body — headers Dropbox-API-Arg

Field	Type	Presence	Description and constraints
$	object	Root
close	boolean	Optional
session_type	JSON	Optional
session_type (anyOf 1)	Model	Alternative	Expand Start a batch of upload sessions — request body — body session type value
session_type (anyOf 2)	null	Alternative
content_hash	JSON	Optional
content_hash (anyOf 1)	string	Alternative	Maximum length: 64 Minimum length: 64
content_hash (anyOf 2)	null	Alternative

Referenced models: Start a batch of upload sessions — request body — body session type value

Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 Mi B — response body

Field	Type	Presence	Description and constraints
$	object	Root
session_id	string	Required within parent