v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Conversation

Gets a list of conversations

Gets a list of conversations with pagination. Filters can be provided in the request body.

get/conversations

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

owner_idstring uuid

Example:eb1ac5c0-ff63-47e2-bcdb-5da9c336eb4b

Filter conversations by the agent currently owning (assigned to) them. When set to a non-nil UUID, only conversations whose owner_id matches that UUID are returned. Omitting the parameter — or passing the nil UUID (00000000-0000-0000-0000-000000000000) — disables the filter and returns all conversations visible to the caller.

Permission rule: an agent caller (non-admin, non-manager) MUST set owner_id to their own agent ID; otherwise the request is rejected with 403. Admin and manager callers may pass any owner_id or omit the filter entirely.

Request body

customer_idstring uuid

Filter by customer ID

account_idstring uuid

Filter by account ID

dialog_idstring

Filter by dialog ID

type'message' | 'line'

Filter by conversation type

deletedboolean

Include deleted conversations if true

Response

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "owner_type": "agent",
      "owner_id": "c2d3e4f5-a6b7-8901-2cde-f01234567890",
      "account_id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Customer Support Chat",
      "detail": "Support conversation with customer",
      "type": "message",
      "dialog_id": "chatroom-abc123",
      "self": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "peer": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}