Join the Dialogflow CX competition! Get trained in Dialogflow CX, work on open-source conversational components, get a free Dialogflow t-shirt and win cool prizes! Learn more.

Method: projects.locations.agents.entityTypes.list

Returns the list of all entity types in the specified agent.

HTTP request

GET https://dialogflow.googleapis.com/v3/{parent=projects/*/locations/*/agents/*}/entityTypes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The agent to list all entity types for. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.entityTypes.list

Query parameters

Parameters
languageCode

string

The language to list entity types for. The following fields are language dependent:

  • EntityType.entities.value
  • EntityType.entities.synonyms
  • EntityType.excluded_phrases.value

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.

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

If successful, the response body contains data with the following structure:

The response message for EntityTypes.ListEntityTypes.

JSON representation
{
  "entityTypes": [
    {
      object (EntityType)
    }
  ],
  "nextPageToken": string
}
Fields
entityTypes[]

object (EntityType)

The list of entity types. There will be a maximum number of items returned based on the pageSize field in the request.

nextPageToken

string

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.