POST /2/files/list_folder
list_folder
scope: files.metadata.read
Starts returning the contents of a folder. If the result's ListFolderResult.has_more field is true, call list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries.
If you're using ListFolderArg.recursive set to true to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:
For each FileMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.
For each FolderMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's FolderSharingInfo.read_only and set all its children's read-only statuses to match.
For each DeletedMetadata, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.
Note: auth.RateLimitError may be returned if multiple list_folder or list_folder/continue calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.
Servers
- https://api.dropboxapi.com
- https://content.dropboxapi.com
- https://notify.dropboxapi.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
dropbox-api-path-root |
String | No | |
dropbox-api-select-user |
String | No | |
dropbox-api-select-admin |
String | No |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
include_non_downloadable_files |
Boolean | No | |
include_mounted_folders |
Boolean | No | |
include_has_explicit_shared_members |
Boolean | No | |
recursive |
Boolean | No | |
include_media_info |
Boolean | No | |
path |
String | No | |
include_deleted |
Boolean | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.