Required. The parent resource name. In the format:projects/{projectId}/databases/{databaseId}/documentsorprojects/{projectId}/databases/{databaseId}/documents/{document_path}.
For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroom
collectionId
string
Optional. The collection ID, relative toparent, to list.
For example:chatroomsormessages.
This is optional, and when not provided, Firestore will list documents from all collections under the providedparent.
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of documents to return in a single response.
Firestore may return fewer than this value.
pageToken
string
Optional. A page token, received from a previousdocuments.listresponse.
Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception ofpageSize) must match the values set in the request that generated the page token.
orderBy
string
Optional. The optional ordering of the documents to return.
For example:priority desc, __name__ desc.
This mirrors theORDER BYused in Firestore queries but in a string representation. When absent, documents are ordered based on__name__ ASC.
Optional. 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 document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields,createTime, orupdateTimeset.
Requests withshowMissingmay not specifywhereororderBy.
Union parameterconsistency_selector. The consistency mode for this transaction. If not set, defaults to strong consistency.consistency_selectorcan be only one of the following:
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z"or"2014-10-02T15:01:23+05:30".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis API endpoint retrieves a list of documents from Firestore, using a \u003ccode\u003eGET\u003c/code\u003e HTTP request to a specific URL structure.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e and \u003ccode\u003ecollectionId\u003c/code\u003e path parameters are used to specify the location of the documents within the Firestore database, with \u003ccode\u003ecollectionId\u003c/code\u003e being optional and allowing for listing documents from all collections if omitted.\u003c/p\u003e\n"],["\u003cp\u003eVarious query parameters such as \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, \u003ccode\u003emask\u003c/code\u003e, and \u003ccode\u003eshowMissing\u003c/code\u003e can be used to refine the list of documents returned, controlling pagination, sorting, field selection, and whether to include missing documents.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003econsistency_selector\u003c/code\u003e union parameter allows the user to select between strong consistency, read as part of a transaction or at a specified \u003ccode\u003ereadTime\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires one of two specified OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/datastore\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.databases.documents.list\n\nLists documents.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListDocumentsResponse](/firestore/docs/reference/rest/v1/ListDocumentsResponse).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
