Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset It takes the form projects/{project}/locations/{location}/processors/{processor}/dataset.
Request body
The request body contains data with the following structure:
The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken
string
A page token, received from a previous dataset.listDocuments call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to dataset.listDocuments must match the call that provided the page token.
Note: - Only AND, = and != are supported. e.g. DisplayName=fileName AND EntityType!=abc IS supported. - Wildcard * is supported only in DisplayName filter - No duplicate filter keys are allowed, e.g. EntityType=a AND EntityType=b is NOT supported. - String match is case sensitive (for filter DisplayName & EntityType).
[[["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-10 UTC."],[[["\u003cp\u003eThis endpoint, \u003ccode\u003eprojects.locations.processors.dataset.listDocuments\u003c/code\u003e, retrieves a list of documents within a specified dataset.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the dataset's resource name as a path parameter, using the format \u003ccode\u003eprojects/{project}/locations/{location}/processors/{processor}/dataset\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request body supports filtering, pagination, and skipping results, allowing you to specify \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003ereturnTotalSize\u003c/code\u003e, and \u003ccode\u003eskip\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes \u003ccode\u003edocumentMetadata\u003c/code\u003e, \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and \u003ccode\u003etotalSize\u003c/code\u003e representing the total number of documents queried.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint requires OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003edocumentai.datasets.listDocuments\u003c/code\u003e to access the \u003ccode\u003edataset\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,["# Method: dataset.listDocuments\n\n**Full name**: projects.locations.processors.dataset.listDocuments\n\nReturns a list of documents present in the dataset.\n\n### HTTP request\n\n`POST https://{endpoint}/v1beta3/{dataset}:listDocuments`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/document-ai/docs/reference/rest#rest_endpoints).\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `dataset` resource:\n\n- `documentai.datasets.listDocuments`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nDocumentMetadata\n----------------\n\nMetadata about a document.\n\nDocumentLabelingState\n---------------------\n\nDescribes the labeling status of a document."]]