List conversations

Authorizations

Authorization

string

header

required

Personal access token. See Authentication.

Query Parameters

direction

enum<string>

Filter by direction. Who initiated the conversation.

Available options:

inbound,

outbound

channel

enum<string>

Filter by channel. The conversation channel.

Available options:

telephone,

webrtc,

email,

text

status

enum<string>

Filter by status. Current state of the conversation.

Available options:

token_created,

triggered,

ringing,

in_progress,

completed,

failed,

cancelled,

transferred,

unanswered

user_id

string

Filter by user ID (partial match).

agent_id

string

Filter by agent ID.

agent_version_id

string

Filter by agent version ID.

agent_number

string

Filter by agent phone number (partial match).

Filter by web widget ID.

duration_above

integer

Only conversations lasting at least this many seconds.

duration_below

integer

Only conversations lasting at most this many seconds.

user_turn_count_above

integer

Only conversations with at least this many user turns.

user_turn_count_below

integer

Only conversations with at most this many user turns.

custom_metadata

string

Match against attached metadata. Must be a JSON object string, e.g. {"order_id":"123"}.

created_after

string<date-time>

Conversations created on or after this time.

created_before

string<date-time>

Conversations created on or before this time.

updated_after

string<date-time>

Conversations updated on or after this time.

updated_before

string<date-time>

Conversations updated on or before this time.

limit

integer

default:100

Maximum number of conversations to return.

Required range: 1 <= x <= 1000

cursor

string

Base64-encoded pagination cursor (the ISO 8601 created_at of the last item from the previous page).

columns

string

Comma-separated list of fields to return, e.g. id,status,created_at.

Response

A list of conversations.

string

Unique conversation ID.

organization_id

string

Your organization ID.

direction

enum<string>

Who initiated the conversation.

Available options:

inbound,

outbound

channel

enum<string>

The conversation channel.

Available options:

telephone,

webrtc,

email,

text

status

enum<string>

Current state of the conversation.

Available options:

token_created,

triggered,

ringing,

in_progress,

completed,

failed,

cancelled,

transferred,

unanswered

user_id

string

The end user's identifier (a phone number for telephony).

agent_id

string

The agent handling the conversation.

agent_version_id

string

The specific agent version in use.

agent_number

string

The agent's phone number (telephony).

The web widget that originated the conversation, if any.

duration

integer | null

Conversation length in seconds.

user_turn_count

integer | null

Number of user turns.

created_at

string<date-time>

Creation timestamp.

updated_at

string<date-time>

Last-update timestamp.

agent

object

Sensitive. The handling agent.

Show child attributes

summary

string

Sensitive. Generated conversation summary.

initial_context

string

Sensitive. Context injected into the agent at the start of the conversation.

custom_metadata

object | null

Sensitive. Metadata you attached when creating the conversation.

conversation

object | null

Sensitive. The transcript.

recording_details

object | null

Sensitive. Recording information, including a time-limited recording_url.