Method: documents.list

Lists documents for the authenticated caller with cursor pagination.

Each returned document includes its latestReviewSummary when a review exists.

HTTP request

GET https://deepreview.googleapis.com/v1/documents

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of documents to return in a single page. The server may return fewer than this value. If unspecified, at most 50 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageToken

string

Optional. A page token received from a previous documents.list call.

filter

string

Optional. Custom filter expressions are not currently supported; non-empty values return INVALID_ARGUMENT.

orderBy

string

Optional. Custom orderBy expressions are not currently supported; non-empty values return INVALID_ARGUMENT.

Request body

The request body must be empty.

Response body

Response message for listing Document resources.

If successful, the response body contains data with the following structure:

JSON representation
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}
Fields
documents[]

object (Document)

The list of Document resources.

nextPageToken

string

A token to retrieve the next page of results, or empty if no further pages exist.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.