Skip to navigation
Dropbox APIUser EndpointsFiles

List Folder Longpoll

View as Markdown

A longpoll endpoint to wait for changes on an account. In conjunction with list_folder/continue, this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps.

Required scope: files.metadata.read

Endpoint format: RPC

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

Request

This endpoint expects an object.
cursorstringRequired>=1 character

A cursor as returned by list_folder or list_folder/continue. Cursors retrieved by setting ListFolderArg.include_media_info to true are not supported.

timeoutuint64Optional30-480Defaults to 30
A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

Response headers

X-Dropbox-Request-IdstringOptional
A unique identifier for the request, useful for debugging and support.

Response

Successful response
changesboolean

Indicates whether new changes are available. If true, call list_folder/continue to retrieve the changes.

backoffuint64 or nullOptional>=0

If present, backoff for at least this many seconds before calling list_folder/longpoll again.

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error