Developer Docs Logo
API RequestsAPI SchemaChats

Get Conversation List

GET/v1/conversations

Retrieves a paginated list of conversations with filtering options. Supports filtering by assignee, contact, status, date range, and channel. Requires chat:read scope.

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

assignee_ids?string

Filter by assigned agent IDs (comma-separated UUIDs). Returns conversations matching any of the specified agents.

contact_ids?string

Filter by contact IDs (comma-separated UUIDs). Returns conversations matching any of the specified contacts.

status?string

Filter by conversation status.

Value in

  • "OPEN"
  • "RESOLVED"
  • "FINALIZED"
date_range_by?string

Field to use for date range filtering.

Value in

  • "created_at"
  • "last_message_time"
timezone?string

Timezone for date filtering (IANA timezone name).

Default"Asia/Jakarta"
start_at?string

Start date for filtering conversations (ISO 8601 date-time).

Formatdate-time
end_at?string

End date for filtering conversations (ISO 8601 date-time).

Formatdate-time
channel_ids?string

Filter by channel IDs (comma-separated UUIDs). Returns conversations matching any of the specified channels.

limit?integer

Maximum number of results per page (max 100).

Rangevalue <= 100
after?string

Cursor for pagination (get next page).

Formatuuid
before?string

Cursor for pagination (get previous page).

Formatuuid
sort_by?string

Sort order for results (-created_at for newest first, +created_at for oldest first, -last_message_time for most recent message first, +last_message_time for oldest message first).

Default"-created_at"

Value in

  • "-created_at"
  • "+created_at"
  • "-last_message_time"
  • "+last_message_time"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/conversations"
{  "data": [    {      "id": "7c9b5f38-76b6-4c7e-a0c9-5fb6f8c6d0d3",      "status": "OPEN",      "channel_id": "a24f8ef9-2da9-47e0-9be5-0dbeb40a8d54",      "created_at": "2024-01-15T10:00:00Z",      "contact_id": "550e8400-e29b-41d4-a716-446655440000",      "assignee_id": "9e9097a8-5c9a-4e1e-8218-3b833d8b0039"    }  ],  "metadata": {    "after": "7a30ad46-76a3-42df-9c0c-3fcf1b10f9d2",    "before": "2db87b94-212f-4f6f-badd-03b6dd6a1a4e"  }}

Get Conversation Detail GET

Retrieves detailed information about a specific conversation including participants and status. Requires `chat:read` scope.

Get Conversation Messages GET

Retrieves messages from a conversation with pagination support. Messages can be sorted by creation date. Requires `chat:read` scope.