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 API endpoint retrieves a list of \u003ccode\u003eDocument\u003c/code\u003e resources from a specified branch within a data store.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e path parameter is required and specifies the branch from which to list documents, using \u003ccode\u003edefault_branch\u003c/code\u003e for the default branch.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epageSize\u003c/code\u003e query parameter controls the maximum number of documents returned, with a default of 100 and a maximum of 1000.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003epageToken\u003c/code\u003e query parameter allows for pagination, retrieving subsequent pages of documents based on a previous response token.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this API requires the \u003ccode\u003ediscoveryengine.documents.list\u003c/code\u003e IAM permission on the parent resource and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]
