Dropbox API

By Abhishek Kumar
4 min read
Dropbox reduces busywork by providing cloud storage and file synchronization. Leverage the Dropbox API for seamless integration, file management, and real-time updates

Table of Contents

Dropbox is a modern workspace designed to reduce busywork so you can focus on the things that matter. Sign in and put your creative energy to work.

API Overview

Dropbox is a file hosting service that offers cloud storage, file synchronization, personal cloud, and client software. It allows users to store files online and access them from any device with an internet connection. Dropbox also allows users to share files and folders with others and collaborate on documents. The service is available as a website, desktop application, and mobile app.

Dropbox API provides a comprehensive set of REST APIs and webhooks that enable developers to integrate Dropbox functionality into their applications. The API documentation is extensive and provides clear instructions on how to use the various endpoints. The REST APIs allow developers to perform a wide range of operations, such as creating and managing files and folders, sharing files and folders, and streaming files. Webhooks allow developers to receive notifications when certain events occur in a Dropbox account, such as when a file is added, modified, or deleted. Dropbox also imposes rate limits to prevent abuse of the API. Developers can monitor their API usage through the API console and adjust their usage patterns accordingly.

API Request Limits

Free

20 requests per second

Plus

100 requests per second

Professional

200 requests per second

Business

300 requests per second

APIs

Files

Method: get_metadata

Description: Returns the metadata for a file or folder..

Endpoint: /files/get_metadata

Parameters: path, include_media_info, include_deleted, include_has_explicit_shared_members

Files

Method: create_folder

Description: Creates a new folder in the user’s Dropbox..

Endpoint: /files/create_folder

Parameters: path, autorename

Files

Method: delete_v2

Description: Deletes a file or folder..

Endpoint: /files/delete_v2

Parameters: path, parent_rev

Files

Method: get_temporary_link

Description: Get a temporary link to stream content of a file. This link will expire in four hours..

Endpoint: /files/get_temporary_link

Parameters: path

Files

Method: list_folder

Description: Returns a list folder response..

Endpoint: /files/list_folder

Parameters: path, recursive, include_media_info, include_deleted, include_has_explicit_shared_members, limit

Files

Method: download

Description: Download a file’s contents..

Endpoint: /files/download

Parameters: path, rev

Files

Method: upload

Description: Upload a file’s contents..

Endpoint: /files/upload

Parameters: path, mode, autorename, mute, strict_conflict

Sharing

Method: get_shared_link_file

Description: Get the shared link’s metadata..

Endpoint: /sharing/get_shared_link_file

Parameters: url

Sharing

Method: share_folder

Description: Shares a folder..

Endpoint: /sharing/share_folder

Parameters: folder, shared_folder_id, members, quiet, force_async

Sharing

Method: get_shared_links

Description: Gets a list of shared link metadata at the provided path..

Endpoint: /sharing/get_shared_links

Parameters: path

Sharing

Method: create_shared_link

Description: Creates a shared link..

Endpoint: /sharing/create_shared_link

Parameters: path, short_url, expires

Sharing

Method: list_folders

Description: Get a list of all shared folders the current user has access to..

Endpoint: /sharing/list_folders

Parameters: limit, shared_link_user

Sharing

Method: list_shared_links

Description: Return a list of LinkMetadata objects for this user, including collection links.

Endpoint: /sharing/list_shared_links

Parameters: cursor, direct_only, limit, path, shared_link_user

Users

Method: get_current_account

Description: Gets information about the current user’s Dropbox account..

Endpoint: /users/get_current_account

Parameters: None

Routes

Method: get_user_account

Description: Returns the user’s account info..

Endpoint: /users/get_account

Parameters: account_id

Routes

Method: get_account

Description: Returns the user’s account info..

Endpoint: /users/get_account

Parameters: account_id

Search

Method: search

Description: Searches for files and folders..

Endpoint: /search/search

Parameters: query, file_status, sort_order, sort_by, match_field, mode, include_highlights

Teams

Method: get_team

Description: Gets information about a team..

Endpoint: /teams/get_team

Parameters: team_id

Teams

Method: members_add

Description: Adds members to a team..

Endpoint: /teams/members/add

Parameters: team_id, members

Teams

Method: list_team_members

Description: Lists members of a team..

Endpoint: /teams/list_team_members

Parameters: team_id

Teams

Method: list_team_invitations

Description: Lists outstanding invitations for a team.

Endpoint: /teams/list_team_invitations

Parameters: team_id

TeamReports

Method: get_team_activity

Description: Get the activity feed for a team..

Endpoint: /team_reports/get_team_activity

Parameters: team_id, start_time, end_time, limit

TeamReports

Method: get_activity_report

Description: Get the weekly activity report for a team..

Endpoint: /team_reports/get_activity_report

Parameters: team_id, start_date, end_date

Members

Method: get_members_info

Description: Retrieves information about members of the file..

Endpoint: /sharing/get_members_info

Parameters: shared_folder_id, members

Members

Method: remove_member

Description: Removes members from this file..

Endpoint: /sharing/remove_member

Parameters: shared_folder_id, member

FileRequests

Method: list_file_requests

Description: List all file requests to a user’s Dropbox..

Endpoint: /file_requests/list_file_requests

Parameters: status, limit

FileRequests

Method: get_file_request

Description: Returns the specified file request..

Endpoint: /file_requests/get_file_request

Parameters: id

FileRequests

Method: create_file_request

Description: Creates a new file request..

Endpoint: /file_requests/create_file_request

Parameters: title, destination, deadline, open, file_requests_enabled, add_files_enabled

FileRequests

Method: update_file_request

Description: Updates an existing file request..

Endpoint: /file_requests/update_file_request

Parameters: id, title, destination, deadline, open, file_requests_enabled, add_files_enabled, allow_direct_file_requests

FileRequests

Method: delete_file_request

Description: Delete a file request with the specified ID..

Endpoint: /file_requests/delete_file_request

Parameters: id

FAQ

How do I authenticate with Dropbox API?

To authenticate with the Dropbox API, you can use OAuth2 with the Authorization Code Grant flow. This will involve getting authorization from the user, exchanging the authorization code for an access token, and using the access token to make API requests.

What are the rate limits for the Dropbox API?

The Dropbox API has rate limits in place to prevent excessive usage. The limits vary depending on the endpoint and your app's tier. You can check the documentation for the specific endpoint you're using for details.

How do I create a sandbox account for development purposes?

To create a sandbox account for development, you can use the Dropbox Developer Console. A sandbox account allows you to test your app without affecting production data.

What are the benefits of using the Dropbox API?

Using the Dropbox API allows you to integrate Dropbox functionality into your application, such as file storage, sharing, and collaboration. It provides a secure and reliable way to interact with Dropbox data.

How do I handle authentication errors when using the Dropbox API?

When handling authentication errors, you should check the error code and message to determine the cause of the error. Common errors include invalid credentials, expired tokens, or insufficient permissions.

Last Update: September 05, 2024