2022-03-16
▼ ▲ firestore.projects.databases.documents.listDocuments
Description : Lists documents.
Flat Path : v1/projects/{projectsId}/databases/{databasesId}/documents/{collectionId}
Scopes :
Parameter Order :
Path : v1/{+parent}/{collectionId}
Parameters :
readTime
Location : query
Description : Reads documents as they were at the given time. This may not be older than 270 seconds.
Format : google-datetime
Type : string
showMissing
Type : boolean
Description : 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 `show_missing` may not specify `where` or `order_by`.
Location : query
collectionId
Type : string
Description : Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.
Location : path
Required : Yes
pageSize
Type : integer
Format : int32
Description : The maximum number of documents to return.
Location : query
parent
Description : Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
Type : string
Pattern : ^projects/[^/]+/databases/[^/]+/documents$
Required : Yes
Location : path
orderBy
Location : query
Description : The order to sort results by. For example: `priority desc, name`.
Type : string
pageToken
Location : query
Type : string
Description : The `next_page_token` value returned from a previous List request, if any.
mask.fieldPaths
Type : string
Description : The list of field paths in the mask. See Document.fields for a field path syntax reference.
Repeated : Yes
Location : query
transaction
Description : Reads documents in a transaction.
Location : query
Format : byte
Type : string
HTTP Method : GET