Skip to main content
GET
List conversations

Authorizations

X-API-Key
string
header
required

Path Parameters

account_id
string
required

Query Parameters

conversation_id
string<uuid4> | null

Filter by conversation identifier.

agent_id
string<uuid4> | null

Filter by agent UUID.

type
enum<string> | null

Filter by conversation type (phone, web, or test).

Available options:
phone,
web,
test,
unknown
status
enum<string> | null

Filter by lifecycle status (in_progress, completed, failed, transferred).

Available options:
in_progress,
completed,
failed,
transferred
direction
enum<string> | null

Filter by conversation direction (inbound or outbound).

Available options:
inbound,
outbound,
internal
created_after
string<date-time> | null

Return conversations created on/after this timestamp.

created_before
string<date-time> | null

Return conversations created before this timestamp.

updated_after
string<date-time> | null

Return conversations updated on/after this timestamp.

updated_before
string<date-time> | null

Return conversations updated before this timestamp.

Response

OK

count
integer
required
items
ConversationListItemSchema · object[]
required