v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-0510371832.3 KB
ConversationsV1Conversation

Retrieve a list of conversations in your account's default service

Retrieve a list of conversations in your account's default service

get/v1/Conversations

Query parameters

StartDatestring

Specifies the beginning of the date range for filtering Conversations based on their creation date. Conversations that were created on or after this date will be included in the results. The date must be in ISO8601 format, specifically starting at the beginning of the specified date (YYYY-MM-DDT00:00:00Z), for precise filtering. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.

EndDatestring

Defines the end of the date range for filtering conversations by their creation date. Only conversations that were created on or before this date will appear in the results. The date must be in ISO8601 format, specifically capturing up to the end of the specified date (YYYY-MM-DDT23:59:59Z), to ensure that conversations from the entire end day are included. This parameter can be combined with other filters. If this filter is used, the returned list is sorted by latest conversation creation date in descending order.

State'initializing' | 'inactive' | 'active' | 'closed'

Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active

State for sorting and filtering list of Conversations. Can be active, inactive or closed

PageSizeinteger

How many resources to return in each list page. The default is 50, and the maximum is 100.

Pageinteger

The page index. This value is simply for client state.

PageTokenstring

The page token. This is provided by the API.

Response

OK