Method: projects.locations.conversations.list

Returns the list of all conversations in the specified project.

HTTP request

GET https://{endpoint}/v2/{parent=projects/*/locations/*}/conversations

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project from which to list all conversation. Format: projects/<Project ID>/locations/<Location ID>.

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

  • dialogflow.conversations.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 value returned from a previous list request.

filter

string

A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering:

  • The value must be a string, a number, or a boolean.
  • The comparison operator must be either =,!=, >, or <.
  • To filter on multiple expressions, separate the expressions with AND or OR (omitting both implies AND).
  • For clarity, expressions can be enclosed in parentheses.
Only lifecycleState can be filtered on in this way. For example, the following expression only returns COMPLETED conversations:

lifecycleState = "COMPLETED"

For more information about filtering, see API Filtering.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListConversationsResponse.

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.