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