List files and folders with the Dropbox API
Lists the files and folders inside a folder, each with .tag (file, folder or deleted), name, path_display and id. When has_more is true, pass the cursor to List more files for the rest.
- Identifier
- dropbox_list_files
The request
POST https://connect.reportei.com/api/tools/dropbox_list_files/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"path": "<path>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | Folder to list, like /Clients/Acme, or an empty string for the root folder. Paths start with a slash, never end with one and ignore case. A folder id (id:...) from this tool or Search files also works. On team accounts with team space, the root is the member's own folder. |
| recursive | boolean | No | When true, also lists the contents of every subfolder. Very large folders can be slow or fail this way; list them level by level instead. |
| include_deleted | boolean | No | When true, also returns files and folders that were deleted, as entries with .tag deleted. |
| include_mounted_folders | boolean | No | When false, leaves out the contents of shared folders, team folders and app folders inside the path. Defaults to true. |
| include_non_downloadable_files | boolean | No | When false, leaves out files that cannot be downloaded, such as Google Docs. Defaults to true. |
| limit | integer | No | Approximate maximum number of entries per page, up to 2000. |
Supported connections
Your customer connects their Dropbox account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/dropbox, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/dropbox_list_files. It becomes your agent's tool definition with no conversion.
Other Dropbox tools
- List more filesPOSTReturns the next page of a listing started by List files and folders, with the same options. Call it again with the new cursor while has_more is true.
- Search filesPOSTSearches files and folders and returns up to max_results matches, each with the item under metadata.metadata. When has_more is true, narrow the query or the folder. Changes from the last moments may not show yet.
- Get file or folderPOSTReturns the metadata of a file or folder: .tag (file or folder), name, path_display, id and, for files, size, rev and the modification dates. The root folder has no metadata.
- Create folderPOSTCreates a folder and returns its metadata under metadata.
- Move or rename filePOSTMoves or renames a file or folder; a folder moves with everything inside it. Returns the new metadata under metadata. Changing only the case of a name is not supported.
- Copy file or folderPOSTCopies a file or folder; a folder is copied with everything inside it. Returns the metadata of the copy under metadata.
- Delete file or folderPOSTDeletes a file or folder; a folder is deleted with everything inside it. Returns the metadata the item had under metadata. Dropbox keeps deleted items restorable for a period that depends on the plan.
- Get temporary linkPOSTReturns a direct link to the content of a file, valid for four hours, plus the file metadata. Anyone with the link can download the file until it expires; for a lasting link, use Create shared link.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
