Optional. The optional ordering of the documents to return.
For example: priority desc, __name__ desc.
This mirrors the [ORDER BY][google.firestore.v1.StructuredQuery.order_by]
used in Firestore queries but in a string representation. When absent,
documents are ordered based on __name__ ASC.
Optional. A page token, received from a previous ListDocuments response.
Provide this to retrieve the subsequent page. When paginating, all other
parameters (with the exception of page_size) must match the values set
in the request that generated the page token.
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
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.
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,
[create_time][google.firestore.v1.Document.create_time], or
[update_time][google.firestore.v1.Document.update_time] set.
Requests with show_missing may not specify where or order_by.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document outlines the \u003ccode\u003eListDocumentsRequest\u003c/code\u003e class, which is used to request a list of documents from the Firestore API.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available for \u003ccode\u003eListDocumentsRequest\u003c/code\u003e is 3.10.0, with previous versions ranging from 3.9.0 down to 2.3.0, each linked to its own documentation.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eListDocumentsRequest\u003c/code\u003e can implement \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, \u003ccode\u003eIBufferMessage\u003c/code\u003e, and \u003ccode\u003eIPageRequest\u003c/code\u003e interfaces.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the class include \u003ccode\u003eCollectionId\u003c/code\u003e, \u003ccode\u003eParent\u003c/code\u003e, \u003ccode\u003ePageSize\u003c/code\u003e, \u003ccode\u003ePageToken\u003c/code\u003e, \u003ccode\u003eMask\u003c/code\u003e, \u003ccode\u003eOrderBy\u003c/code\u003e, \u003ccode\u003eReadTime\u003c/code\u003e, \u003ccode\u003eShowMissing\u003c/code\u003e and \u003ccode\u003eTransaction\u003c/code\u003e, allowing for specifying the scope and detail of the document listing.\u003c/p\u003e\n"],["\u003cp\u003eThe request can be performed at a specific time in the past, with a microsecond precision timestamp, and can be executed as part of an active transaction.\u003c/p\u003e\n"]]],[],null,["# Firestore v1 API - Class ListDocumentsRequest (3.10.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.10.0 (latest)](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.9.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.9.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.8.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.8.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.7.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.7.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.6.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.6.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.5.1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.5.1/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.4.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.3.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.2.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.1.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/3.0.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [2.5.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.5.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [2.4.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.4.0/Google.Cloud.Firestore.V1.ListDocumentsRequest)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.Firestore.V1/2.3.0/Google.Cloud.Firestore.V1.ListDocumentsRequest) \n\n public sealed class ListDocumentsRequest : IMessage\u003cListDocumentsRequest\u003e, IEquatable\u003cListDocumentsRequest\u003e, IDeepCloneable\u003cListDocumentsRequest\u003e, IBufferMessage, IMessage, IPageRequest\n\nReference documentation and code samples for the Firestore v1 API class ListDocumentsRequest.\n\nThe request for\n\\[Firestore.ListDocuments\\]\\[google.firestore.v1.Firestore.ListDocuments\\]. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e ListDocumentsRequest \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.ListDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.ListDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListDocumentsRequest](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1.ListDocumentsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Firestore.V1](/dotnet/docs/reference/Google.Cloud.Firestore.V1/latest/Google.Cloud.Firestore.V1)\n\nAssembly\n--------\n\nGoogle.Cloud.Firestore.V1.dll\n\nConstructors\n------------\n\n### ListDocumentsRequest()\n\n public ListDocumentsRequest()\n\n### ListDocumentsRequest(ListDocumentsRequest)\n\n public ListDocumentsRequest(ListDocumentsRequest other)\n\nProperties\n----------\n\n### CollectionId\n\n public string CollectionId { get; set; }\n\nOptional. The collection ID, relative to `parent`, to list.\n\nFor example: `chatrooms` or `messages`.\n\nThis is optional, and when not provided, Firestore will list documents\nfrom all collections under the provided `parent`.\n\n### ConsistencySelectorCase\n\n public ListDocumentsRequest.ConsistencySelectorOneofCase ConsistencySelectorCase { get; }\n\n### HasTransaction\n\n public bool HasTransaction { get; }\n\nGets whether the \"transaction\" field is set\n\n### Mask\n\n public DocumentMask Mask { get; set; }\n\nOptional. The fields to return. If not set, returns all fields.\n\nIf a document has a field that is not present in this mask, that field\nwill not be returned in the response.\n\n### OrderBy\n\n public string OrderBy { get; set; }\n\nOptional. The optional ordering of the documents to return.\n\nFor example: `priority desc, __name__ desc`.\n\nThis mirrors the \\[`ORDER BY`\\]\\[google.firestore.v1.StructuredQuery.order_by\\]\nused in Firestore queries but in a string representation. When absent,\ndocuments are ordered based on `__name__ ASC`.\n\n### PageSize\n\n public int PageSize { get; set; }\n\nOptional. The maximum number of documents to return in a single response.\n\nFirestore may return fewer than this value.\n\n### PageToken\n\n public string PageToken { get; set; }\n\nOptional. A page token, received from a previous `ListDocuments` response.\n\nProvide this to retrieve the subsequent page. When paginating, all other\nparameters (with the exception of `page_size`) must match the values set\nin the request that generated the page token.\n\n### Parent\n\n public string Parent { get; set; }\n\nRequired. The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\n\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`\n\n### ReadTime\n\n public Timestamp ReadTime { get; set; }\n\nPerform the read at the provided time.\n\nThis must be a microsecond precision timestamp within the past one hour,\nor if Point-in-Time Recovery is enabled, can additionally be a whole\nminute timestamp within the past 7 days.\n\n### ShowMissing\n\n public bool ShowMissing { get; set; }\n\nIf the list should show missing documents.\n\nA document is missing if it does not exist, but there are sub-documents\nnested underneath it. When true, such missing documents will be returned\nwith a key but will not have fields,\n\\[`create_time`\\]\\[google.firestore.v1.Document.create_time\\], or\n\\[`update_time`\\]\\[google.firestore.v1.Document.update_time\\] set.\n\nRequests with `show_missing` may not specify `where` or `order_by`.\n\n### Transaction\n\n public ByteString Transaction { get; set; }\n\nPerform the read as part of an already active transaction."]]
