Skip to navigation
Dropbox APIUser EndpointsPaper

Docs List

Deprecated
View as Markdown

Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to docs/list/continue. Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper. Refer to the Paper Migration Guide for migration information.

Required scope: files.metadata.read

Endpoint format: RPC

Authentication: User

This endpoint does not support apps with the app folder permission.

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.

Headers

Dropbox-API-Select-UserstringOptional

Acts on behalf of a team member for supported user-auth operations. Pass a team member ID such as dbmid:.... When used with a team token, that token must also include the team_data.member scope.

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.

Request

This endpoint expects a nullable object.
filter_byobject or nullOptional
Allows user to specify how the Paper docs should be filtered.
Variant:
paper_apiv2.ListPaperDocsFilterBy.docs_accessedobjectRequired
Fetches all Paper doc IDs that the user has ever accessed.
limitintegerOptional1-1000Defaults to 1000
Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
sort_byobject or nullOptional
Allows user to specify how the Paper docs should be sorted.
Variant:
paper_apiv2.ListPaperDocsSortBy.accessedobjectRequired
Sorts the Paper docs by the time they were last accessed.
sort_orderobject or nullOptional
Allows user to specify the sort order of the result.
Variant:
paper_apiv2.ListPaperDocsSortOrder.ascendingobjectRequired
Sorts the search result in ascending order.
stop_at_datedatetime or nullOptional
Do not return results beyond this date. Behavior depends on sort order.

Response headers

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

Response

Successful response
cursorobject

Pass the cursor into docs/list/continue to paginate through all files. The cursor preserves all properties as specified in the original call to docs/list.

doc_idslist of strings

The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to docs/list.

has_moreboolean

Will be set to True if a subsequent call with the provided cursor to docs/list/continue returns immediately with some results. If set to False please allow some delay before making another call to docs/list/continue.

Errors

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