List Folder Get Latest Cursor | Dropbox API Documentation

A way to quickly get a cursor for the folder’s state. Unlike list_folder, list_folder/get_latest_cursor doesn’t return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn’t need to know about files that already exist in Dropbox.

Required scope: files.metadata.read

Endpoint format: RPC

Authentication: User, Dropbox-API-Select-Admin (Whole Team)

A way to quickly get a cursor for the folder's state. Unlike [list_folder](api:dropbox-api:POST/2/files/list_folder), [list_folder/get_latest_cursor](api:dropbox-api:POST/2/files/list_folder/get_latest_cursor) doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox. **Required scope:** `files.metadata.read` **Endpoint format:** [RPC](https://docs.dropboxapi.com/dropbox-api/docs/technical-reference/request-response-formats#rpc-endpoints) **Authentication:** [User](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#user-authentication), [Dropbox-API-Select-Admin (Whole Team)](https://docs.dropboxapi.com/dropbox-api/docs/auth-types#admin-authentication-via-dropbox-api-select-admin)

Authentication

AuthorizationBearer

OAuth 2.0 token issued to a specific user. Use Authorization: Bearer <token>.

Public clients should use the authorization code flow with PKCE (S256).

For background or offline access, send token_access_type=offline during authorization and use the returned refresh token to obtain new access tokens.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

OAuth 2.0 token issued to a specific user. Use `Authorization: Bearer <token>`. Public clients should use the authorization code flow with PKCE (S256). For background or offline access, send `token_access_type=offline` during authorization and use the returned refresh token to obtain new access tokens. You can generate a short-lived access token from the App Console; see [Testing with a generated token](https://docs.dropboxapi.com/dropbox-api/docs/oauth#testing-with-a-generated-token).

Headers

Dropbox-API-Path-RootstringOptional

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the common.PathRoot union: {".tag": "home"}, {".tag": "root", "root": "<namespace_id>"}, or {".tag": "namespace_id", "namespace_id": "<namespace_id>"}. On failure the request returns 422 with a common.PathRootError.

Scopes path-based operations to a namespace (root). The value is a JSON serialization of the `common.PathRoot` union: `{".tag": "home"}`, `{".tag": "root", "root": "<namespace_id>"}`, or `{".tag": "namespace_id", "namespace_id": "<namespace_id>"}`. On failure the request returns 422 with a `common.PathRootError`.

Request

This endpoint expects an object.

pathstringRequiredformat: "(/(.|[\r\n])*)?|id:.*|(ns:[0-9]+(/(.|[\r\n])*)?)"

A unique identifier for the file.

include_deletedbooleanOptionalDefaults to false

If true, the results will include entries for files and folders that used to exist but were deleted.

include_has_explicit_shared_membersbooleanOptionalDefaults to false

If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

include_mounted_foldersbooleanOptionalDefaults to true

If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.

include_non_downloadable_filesbooleanOptionalDefaults to true

If true, include files that are not downloadable, i.e. Google Docs.

include_property_groupsobject or nullOptional

If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.

include_restorable_infobooleanOptionalDefaults to false

If true, each returned deleted entry will include whether that entry can be restored.

limituint or nullOptional1-2000

The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.

recursivebooleanOptionalDefaults to false

If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. In some cases, setting ListFolderArg.recursive to true may lead to performance issues or errors, especially when traversing folder structures with a large number of items. A workaround for such cases is to set ListFolderArg.recursive to false and traverse subfolders one at a time.

shared_linkobject or nullOptional

A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg.path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.

include_media_infobooleanOptionalDefaults to falseDeprecated

If true, FileMetadata.media_info is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

cursorstring>=1 character

Pass the cursor into list_folder/continue to see what’s changed in the folder since your previous query.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error