Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.
Required. The playbook to list the examples from. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>.
Authorization requires the following IAM permission on the specified resource parent:
dialogflow.examples.list
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken
string
Optional. The [nextPageToken][ListExampleResponse.next_page_token] value returned from a previous list request.
languageCode
string
Optional. The language to list examples for. If not specified, list all examples under the playbook. Note: languages must be enabled in the agent before they can be used.
[[["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 webpage details how to list examples within a specific playbook using the Dialogflow CX API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request method is \u003ccode\u003eGET\u003c/code\u003e, and the endpoint URL structure is provided, requiring a \u003ccode\u003eparent\u003c/code\u003e path parameter in the format of \u003ccode\u003eprojects/*/locations/*/agents/*/playbooks/*\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003elanguageCode\u003c/code\u003e can be used to filter and control the examples returned.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, and the response body will contain a list of examples and a \u003ccode\u003enextPageToken\u003c/code\u003e if there are additional results.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully use this endpoint, you must have \u003ccode\u003edialogflow.examples.list\u003c/code\u003e IAM permissions on the parent resource, and it also requires one of the authorization scopes \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/dialogflow\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.playbooks.examples.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListExamplesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of examples in the specified playbook.\n\n### HTTP request\n\n`GET https://{endpoint}/v3beta1/{parent=projects/*/locations/*/agents/*/playbooks/*}/examples`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/cx/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response message for [Examples.ListExamples](/dialogflow/cx/docs/reference/rest/v3beta1/projects.locations.agents.playbooks.examples/list#google.cloud.dialogflow.cx.v3beta1.Examples.ListExamples).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]