Method: conversations.list

Full name: projects.locations.instances.users.conversations.list

conversations.list is used to retrieve existing conversations.

HTTP request


Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of conversations. Format: projects/{project}/locations/{location}/instances/{instance}/users/{user}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of conversations to return. The service may return fewer than this value. If unspecified, at most 100 conversations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous conversations.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to conversations.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for conversations.list method.

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

JSON representation 
{
  "conversations": [
    {
      object (Conversation)
    }
  ],
  "nextPageToken": string
}
Fields
conversations[]

object (Conversation)

The conversations from the specified instance. The conversations are in descending order of their create time.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • chronicle.conversations.list

For more information, see the IAM documentation.