Method: projects.databases.documents.list

Lists documents.

HTTP request

GET https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
parent

string

The parent resource name. In the format: projects/{projectId}/databases/{databaseId}/documents or projects/{projectId}/databases/{databaseId}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

collectionId

string

The collection ID, relative to parent, to list. For example: chatrooms or messages.

Query parameters

Parameters
pageSize

number

The maximum number of documents to return.

pageToken

string

The nextPageToken value returned from a previous List request, if any.

orderBy

string

The order to sort results by. For example: priority desc, name.

mask

object(DocumentMask)

The fields to return. If not set, returns all fields.

If a document has a field that is not present in this mask, that field will not be returned in the response.

showMissing

boolean

If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set.

Requests with showMissing may not specify where or orderBy.

Union parameter consistency_selector. The consistency mode for this transaction. If not set, defaults to strong consistency. consistency_selector can be only one of the following:
transaction

string (bytes format)

Reads documents in a transaction.

A base64-encoded string.

readTime

string (Timestamp format)

Reads documents as they were at the given time. This may not be older than 60 seconds.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

Request body

The request body must be empty.

Response body

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

The response for Firestore.ListDocuments.

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

object(Document)

The Documents found.

nextPageToken

string

The next page token.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

Was this page helpful? Let us know how we did: