Sign in

v2

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-05-071759268.3 KB
Conversations

Retrieve a list of Conversations

Retrieve a list of Conversations processed by an Intelligence Configuration.

get/v3/Conversations

Query parameters

pageSizeinteger

The maximum number of resources to return

pageTokenstring

Token for pagination

createdAtBeforestring date-time

Filter by Conversations created before this timestamp.

createdAtAfterstring date-time

Filter by Conversations created after this timestamp.

status'ACTIVE' | 'INACTIVE' | 'CLOSED'

The status of the Conversation.

Filter by Conversation status.

channelIdstring

Filters Conversations by the underlying channel resource ID, such as a Call ID or Message ID.

channelsstring[]

Filters Conversations that include one or more of the specified communication channels (OR match).

conversationConfigurationIdstring

The id of the Configuration for a Conversation.

Example:conv_configuration_00000000000000000000000000

The configuration id used to generate the Conversation.

intelligenceConfigurationIdsstring[]

Filters Conversations activated by one or more of the specified Intelligence Configuration IDs (OR match).

[
  "intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5"
]
operatorIdsstring[]

Filters Conversations to those where at least one of the specified Language Operators was executed (OR match).

[
  "intelligence_operator_01k6fc25s7epm9qtk8rszbv3q5"
]

Response

An array of Conversations.

Example response

{
  "items": [
    {
      "id": "conv_conversation_01k1etk2y5f1y9fpe2epfdtvv2",
      "intelligenceConfigurationIds": [
        "intelligence_configuration_01k6fc25s7epm9qtk8rszbv3q5"
      ],
      "conversationConfigurationId": "conv_configuration_00000000000000000000000000",
      "participants": [
        {
          "id": "conv_participant_01k1etx3jbfx88476ccja0889c"
        }
      ]
    }
  ]
}