Skip to main content
GET
List Conversations

Path Parameters

agent_id
string
required

Query Parameters

limit
integer | null

Maximum conversations to return. Sending this switches the response to the paged object shape.

Required range: 1 <= x <= 200
cursor
integer | null

Where to resume from: the next_cursor of the previous page. Sending this switches the response to the paged object shape.

Required range: x >= 0
since
number | null

Only conversations created at or after this unix timestamp. Note: created_at is the last time the call's answers were written, not when the call happened, so a call edited later moves.

until
number | null

Only conversations created at or before this unix timestamp. Note: created_at is the last time the call's answers were written, not when the call happened, so a call edited later moves.

status
enum<string> | null

Only conversations with this status.

Available options:
complete,
screened_out,
failed,
in_progress,
not_connected
source
string | null

Only conversations from this source (e.g. twilio, exotel).

include_transcript
boolean
default:false

Include each call's transcript in its row. Off by default; then transcript and has_transcript are absent, not empty.

Response

Successful Response

One row of a conversation list.

transcript and has_transcript are both absent unless the request passed include_transcript=true.

has_recording, has_events, has_log and has_metrics say whether the call has ended, not whether each file is there. The per-conversation routes answer 404 when a specific file is not there.

Cost, duration and latency figures are in the analytics numbers, not here.

conversation_id
string
required
filled_fields
integer
required
form_data
Form Data · object
required
form_status
Form Status · object
required
has_events
boolean
required
has_log
boolean
required
has_metrics
boolean
required
has_recording
boolean
required
is_ended
boolean
required
status
enum<string>
required
Available options:
complete,
screened_out,
failed,
in_progress,
not_connected
total_fields
integer
required
caller_number
string | null
created_at
number | null
has_transcript
boolean | null
source
string | null
transcript
Transcript · object[] | null