Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.
If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Query parameters
Parameters
pageSize
integer
Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
[[["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-06-27 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of \u003ccode\u003eDocument\u003c/code\u003e resources via a \u003ccode\u003eGET\u003c/code\u003e request using the specified URL, which follows gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required to specify the branch resource name, and the \u003ccode\u003edefault_branch\u003c/code\u003e ID can be used to list documents under the default branch.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epageSize\u003c/code\u003e query parameter controls the number of documents returned, defaulting to 100 with a maximum of 1000, and the \u003ccode\u003epageToken\u003c/code\u003e parameter is used for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe request body for this endpoint must be empty, and a successful response will contain an instance of \u003ccode\u003eListDocumentsResponse\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eTo use this endpoint, you must use OAuth with the scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and have the \u003ccode\u003ediscoveryengine.documents.list\u003c/code\u003e IAM permission on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,[]]
