- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IntentView
- Try it!
Returns the list of all intents in the specified agent.
HTTP request
GET https://{endpoint}/v3/{parent=projects/*/locations/*/agents/*}/intents
Where {endpoint}
is one of the supported service endpoints
.
The URLs use gRPC Transcoding syntax.
Path parameters
parent
string
Required. The agent to list all intents for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>
.
Authorization requires the following IAM
permission on the specified resource parent
:
-
dialogflow.intents.list
Query parameters
languageCode
string
The language to list intents for. The following fields are language dependent:
-
Intent.training_phrases.parts.text
If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.
intentView
enum (
IntentView
)
The resource view to apply to the returned intent.
pageSize
integer
The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken
string
The nextPageToken value returned from a previous list request.
Request body
The request body must be empty.
Response body
The response message for Intents.ListIntents
.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"intents"
:
[
{
object (
|
| Fields | |
|---|---|
intents[]
|
The list of intents. There will be a maximum number of items returned based on the pageSize field in the request. |
nextPageToken
|
Token to retrieve the next page of results, or empty if there are no more results in the list. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/cloud-platform -
https://www.googleapis.com/auth/dialogflow
For more information, see the Authentication Overview .
IntentView
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response.
| Enums | |
|---|---|
INTENT_VIEW_UNSPECIFIED
|
Not specified. Treated as INTENT_VIEW_FULL. |
INTENT_VIEW_PARTIAL
|
Training phrases field is not populated in the response. |
INTENT_VIEW_FULL
|
All fields are populated. |
