This namespace contains endpoints and data types for basic file operations.
openapi: 3.0.0
info:
title: Dropbox API Reference Account Files API
description: "The powerful, yet simple, Dropbox API allows you to manage and control content and team settings programmatically and extend Dropbox capabilities in new and powerful ways. This is a collection that includes requests to all endpoints in the Dropbox API. \n\nThe Dropbox API is divided in two groups of endpoints: User Endpoints and Business Endpoints. Operations that would most likely be executed by a user, such as file operations, are in the User Endpoints folder. Operations that would most likely be executed by a team administrator, such as adding users to groups, live in the Business Endpoints folder. \n\nIf you are new to Dropbox Business and Team Administration, please have a look at the [Dropobox Admin Guide](https://help.dropbox.com/guide/admin/how-to-get-started#dropbox-admin-guide). \n\nIf you want more information on how to use our API please refer to our [Developer Portal](https://www.dropbox.com/developers). \n\n# What's in the collection?\n\nThe endpoints are organized in the following folders:\n* account\n* auth\n* check\n* contacts\n* file_properties\n* file_requests\n* files\n* sharing\n* team\n* team_log\n* users\n\n# Authorization\n\n## OAuth 2.0 for API Access\nDropbox uses OAuth 2.0, an open specification, to authorize access to data. To get an OAuth token from Dropbox to enable Postman to access your Dropbox account via the API you’ll need to create a new app on the DBX Platform.\n\n## Creating an App on the DBX Platform\nNavigate to https://www.dropbox.com/developers/apps and select “Create app” \n1. Choose an API \n2. Choose the type of access you need \n3. Give your app a name \n4. Choose the Dropbox account that will own your app \n\nFor reference, please use the [Dropbox OAuth guide](https://www.dropbox.com/lp/developers/reference/oauth-guide) \n\n## Generating an Access Token\nOnce you select “Create app” a page will load that displays information about your newly created app. To generate an access token scroll down to “OAuth 2” and click “Generate” beneath “Generated access token.” The token will display as a long string of characters. Copy this token for use with the Postman Collection.\n\n## Adding an Access Token to the requests\nIn the Postman client, click on the three dots to the right of the collection name to \"View more actions.\"\n\n\n\nThen, click \"Edit.\"\n\nClick on the \"Variables\" tab and, in the row for the `access_token` variable, paste your access token in the `CURRENT VALUE` column. The default value is `your-access-token-here`.\n\n\n\nFor information on sessions and variables in Postman see the blog post at https://blog.postman.com/sessions-faq/.\n\n# Notes\n* Dropbox also has a Postman Collection in the API Network to help administrators with team management workflows. It is called [Dropbox Team Admin Workflows](). \n\n"
version: 1.0.0
servers:
- url: https://api.dropbox.com
security:
- bearerAuth: []
tags:
- name: Files
description: 'This namespace contains endpoints and data types for basic file operations.
'
paths:
/2/files/copy_v2:
post:
tags:
- Files
summary: Dropbox copy
description: '[copy](https://www.dropbox.com/developers/documentation/http/documentation#files-copy)
scope: `files.content.write`
Copy a file or folder to a different location in the user''s Dropbox.
If the source path is a folder all its contents will be copied.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"from_path\": \"/Homework/math\", \n \"to_path\": \"/Homework/algebra\", \n \"allow_shared_folder\": false, \n \"autorename\": false, \n \"allow_ownership_transfer\": false\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
metadata:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/copy_batch_v2:
post:
tags:
- Files
summary: Dropbox copy_batch
description: '[copy_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch)
scope: `files.content.write`
Copy multiple files or folders to different locations at once in the user''s Dropbox.
This route will replace `copy_batch:1`. The main difference is this route will return status for each entry, while `copy_batch:1` raises failure if any entry fails.
This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use `copy_batch/check:2` to check the job status.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"entries\": [\n {\n \"from_path\": \"/Homework/math\", \n \"to_path\": \"/Homework/algebra\"\n }\n ], \n \"autorename\": false\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
.tag: complete
entries:
- .tag: success
success:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/copy_batch/check_v2:
post:
tags:
- Files
summary: Dropbox copy_batch/check
description: '[copy_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_batch-check)
scope: `files.content.write`
Returns the status of an asynchronous job for `copy_batch:2`. It returns list of results for each entry.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"async_job_id\": \"34g93hh34h04y384084\"\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
.tag: complete
entries:
- .tag: success
success:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/copy_reference/get:
post:
tags:
- Files
summary: Dropbox copy_reference/get
description: '[copy_reference/get](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-get)
scope: `files.content.write`
Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user''s Dropbox by passing it to `copy_reference/save`.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"path\": \"/video.mp4\"\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
metadata:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
copy_reference: z1X6ATl6aWtzOGq0c3g5Ng
expires: '2045-05-12T15:50:38Z'
/2/files/copy_reference/save:
post:
tags:
- Files
summary: Dropbox copy_reference/save
description: '[copy_reference/save](https://www.dropbox.com/developers/documentation/http/documentation#files-copy_reference-save)
scope: `files.content.write`
Save a copy reference returned by `copy_reference/get` to the user''s Dropbox.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"copy_reference\": \"z1X6ATl6aWtzOGq0c3g5Ng\", \n \"path\": \"/video.mp4\"\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
metadata:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/create_folder_v2:
post:
tags:
- Files
summary: Dropbox create_folder
description: '[create_folder](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder)
scope: `files.content.write`
Create a folder at a given path.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"path\": \"/Homework/math\", \n \"autorename\": false\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
metadata:
name: math
id: id:a4ayc_80_OEAAAAAAAAAXz
path_lower: /homework/math
path_display: /Homework/math
sharing_info:
read_only: false
parent_shared_folder_id: '84528192421'
traverse_only: false
no_access: false
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
/2/files/create_folder_batch:
post:
tags:
- Files
summary: Dropbox create_folder_batch
description: '[create_folder_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch)
scope: `files.content.write`
Create multiple folders at once.
This route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the `CreateFolderBatchArg.force_async` flag. Use `create_folder_batch/check` to check the job status.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"paths\": [\n \"/Homework/math\"\n ], \n \"autorename\": false, \n \"force_async\": false\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
.tag: complete
entries:
- .tag: success
metadata:
name: math
id: id:a4ayc_80_OEAAAAAAAAAXz
path_lower: /homework/math
path_display: /Homework/math
sharing_info:
read_only: false
parent_shared_folder_id: '84528192421'
traverse_only: false
no_access: false
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
/2/files/create_folder_batch/check:
post:
tags:
- Files
summary: Dropbox create_folder_batch/check
description: '[create_folder_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-create_folder_batch-check)
scope: `files.content.write`
Returns the status of an asynchronous job for `create_folder_batch`. If success, it returns list of result for each entry.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"async_job_id\": \"34g93hh34h04y384084\"\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
.tag: complete
entries:
- .tag: success
metadata:
name: math
id: id:a4ayc_80_OEAAAAAAAAAXz
path_lower: /homework/math
path_display: /Homework/math
sharing_info:
read_only: false
parent_shared_folder_id: '84528192421'
traverse_only: false
no_access: false
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
/2/files/delete_v2:
post:
tags:
- Files
summary: Dropbox delete
description: '[delete](https://www.dropbox.com/developers/documentation/http/documentation#files-delete)
scope: `files.content.write`
Delete the file or folder at a given path.
If the path is a folder, all its contents will be deleted too.
A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding `FileMetadata` or `FolderMetadata` for the item at time of deletion, and not a `DeletedMetadata` object.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"path\": \"/Homework/math/Prime_Numbers.txt\"\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
metadata:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/delete_batch:
post:
tags:
- Files
summary: Dropbox delete_batch
description: '[delete_batch](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch)
scope: `files.content.write`
Delete multiple files/folders at once.
This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use `delete_batch/check` to check the job status.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"entries\": [\n {\n \"path\": \"/Homework/math/Prime_Numbers.txt\"\n }\n ]\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
.tag: complete
entries:
- .tag: success
metadata:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/delete_batch/check:
post:
tags:
- Files
summary: Dropbox delete_batch/check
description: '[delete_batch/check](https://www.dropbox.com/developers/documentation/http/documentation#files-delete_batch-check)
scope: `files.content.write`
Returns the status of an asynchronous job for `delete_batch`. If success, it returns list of result for each entry.'
requestBody:
content:
'*/*':
schema:
type: string
example: '"{\n \"async_job_id\": \"34g93hh34h04y384084\"\n}"'
parameters:
- name: Content-Type
in: header
schema:
type: string
example: application/json
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
.tag: complete
entries:
- .tag: success
metadata:
.tag: file
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/download:
post:
tags:
- Files
summary: Dropbox download
description: '[download](https://www.dropbox.com/developers/documentation/http/documentation#files-download)
scope: `files.content.read`
Download a file from a user''s Dropbox. '
parameters:
- name: Dropbox-API-Arg
in: header
schema:
type: string
example: "{\n \"path\": \"/Homework/math/Prime_Numbers.txt\"\n}"
responses:
'200':
description: OK
headers:
X-Dropbox-Request-Id:
schema:
type: integer
example: '1234'
Content-Type:
schema:
type: string
example: application/json
content:
application/json:
schema:
type: object
example:
name: Prime_Numbers.txt
id: id:a4ayc_80_OEAAAAAAAAAXw
client_modified: '2015-05-12T15:50:38Z'
server_modified: '2015-05-12T15:50:38Z'
rev: a1c10ce0dd78
size: 7212
path_lower: /homework/math/prime_numbers.txt
path_display: /Homework/math/Prime_Numbers.txt
sharing_info:
read_only: true
parent_shared_folder_id: '84528192421'
modified_by: dbid:AAH4f99T0taONIb-OurWxbNQ6ywGRopQngc
is_downloadable: true
property_groups:
- template_id: ptid:1a5n2i6d3OYEAAAAAAAAAYa
fields:
- name: Security Policy
value: Confidential
has_explicit_shared_members: false
content_hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
file_lock_info:
is_lockholder: true
lockholder_name: Imaginary User
created: '2015-05-12T15:50:38Z'
/2/files/download_zip:
post:
tags:
- Files
summary: Dropbox download_zip
description: '[download_zip](https://www.dropbox.com/developers/documentation/http/documentation#files-download_zip)
scope: `files.content.read`
Download a folder from the user''s Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size. '
parameters:
- name: Dropbox-API-Arg
in: header
schema:
type: string
example: "{\n \"path\": \"/Homework/math\"\n}"
responses:
'200':
description: OK
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dropbox/refs/heads/main/openapi/dropbox-files-api-openapi.yml