Skip to main content
GET
Get Calls

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Query Parameters

q
string | null

Search for a specific term across all fields.

term_speaker
enum<string> | null

Search for a specific term spoken by the agent or lead.

Available options:
user,
assistant
action_slug
string | null
deprecated

(Deprecated) Use 'include_action_slugs' instead. Filter calls that have a specific action slug.

call_type
enum<string> | null
deprecated

(Deprecated) Use 'call_types' instead. Show calls of a specific type.

Available options:
outbound,
inbound
conversation_medium
enum<string> | null
deprecated

(Deprecated) Use 'conversation_mediums' instead. Filter by conversation medium.

Available options:
web_voice,
telephony,
sms,
email,
chatbot,
api_text,
chat_app,
softphone
disposition_level_3
string[] | null

Filter by one or more disposition values. You can pass multiple values like: ?disposition_level_3=1&disposition_level_3=2

dispositioned
boolean | null

Filter by whether the call was dispositioned.

twilio_status
enum<string> | null
deprecated

(Deprecated) Use 'twilio_statuses' instead. Filter calls by Twilio status.

Available options:
queued,
initiated,
ringing,
in-progress,
completed,
busy,
failed,
no-answer,
canceled,
voicemail
campaign_id
string | null
deprecated

(Deprecated) Use 'campaign_ids' instead. Show calls for a specific campaign id.

agent_id
string | null
deprecated

(Deprecated) Use 'agent_ids' instead. Show calls of a specific agent.

lead_id
string | null

Show calls of a specific lead.

call_ids
string[] | null

Show calls with specific call ids.

include_action_slugs
string[] | null

Comma-separated list of action slugs that MUST have been called. Takes precedence over action_slug.

exclude_action_slugs
string[] | null

Comma-separated list of action slugs that must NOT have been called.

twilio_statuses
enum<string>[] | null

Comma-separated list of Twilio statuses to filter by. Takes precedence over twilio_status.

Available options:
queued,
initiated,
ringing,
in-progress,
completed,
busy,
failed,
no-answer,
canceled,
voicemail
campaign_ids
string[] | null

Comma-separated list of campaign IDs to filter by. Takes precedence over campaign_id.

agent_ids
string[] | null

Comma-separated list of agent IDs to filter by. Takes precedence over agent_id.

call_types
enum<string>[] | null

Comma-separated list of call types to filter by (inbound, outbound). Takes precedence over call_type.

Available options:
outbound,
inbound
conversation_mediums
enum<string>[] | null

Comma-separated list of conversation mediums to filter by (telephony, web_voice, sms, chatbot, email). Takes precedence over conversation_medium.

Available options:
web_voice,
telephony,
sms,
email,
chatbot,
api_text,
chat_app,
softphone
is_dry_run
boolean | null

Filter by dry-run status. True=only dry-runs, False=exclude dry-runs, None=include all (default).

feedback

Filter calls by feedback type. 'POSITIVE' returns calls with positive feedback, 'NEGATIVE' returns calls with negative feedback, 'any' returns calls with any feedback. Case-insensitive.

Available options:
POSITIVE,
NEGATIVE,
NEUTRAL
feedback_created_gte
string<date-time> | null

Filter calls with feedback created on or after this datetime (inclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-04T00:00:00Z)

feedback_created_lt
string<date-time> | null

Filter calls with feedback created before this datetime (exclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-05T00:00:00Z)

eval_ids
string[] | null

Comma-separated list of evaluation definition IDs to filter by.

grader_names
string[] | null

Comma-separated list of grader names to filter by.

eval_passed
boolean | null

Filter calls by evaluation pass/fail status. True=only passed, False=only failed.

eval_result_gte
number | null

Filter calls with numerical evaluation result greater than or equal to this value (inclusive).

eval_result_lt
number | null

Filter calls with numerical evaluation result less than this value (exclusive).

eval_result_labels
string[] | null

Comma-separated list of evaluation result label values to filter by.

eval_created_gte
string<date-time> | null

Filter calls with evaluation results created on or after this datetime (inclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-04T00:00:00Z)

eval_created_lt
string<date-time> | null

Filter calls with evaluation results created before this datetime (exclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-05T00:00:00Z)

start_date
string<date-time> | null
deprecated

(Deprecated) Use 'created_gte' instead.

end_date
string<date-time> | null
deprecated

(Deprecated) Use 'created_lt' instead.

created_gte
string<date-time> | null

Show conversations that started on or after this datetime (inclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-04T00:00:00Z)

created_lt
string<date-time> | null

Show conversations that started before this datetime (exclusive). Must be in UTC using ISO 8601 format (e.g., 2025-07-05T00:00:00Z)

duration_gte
integer | null

Show conversations lasting at least this many seconds (inclusive). Conversations without a recorded duration are excluded.

Required range: x >= 0
duration_lt
integer | null

Show conversations lasting less than this many seconds (exclusive). Conversations without a recorded duration are excluded.

Required range: x >= 0
offset
integer | null
default:1

The offset for the pagination. If not provided, the first 10 calls will be listed.

Required range: x >= 1
limit
integer | null
default:10

The maximum number of calls to return in the response. If not provided, 10 calls will be listed.

Required range: 1 <= x <= 500
sort_by
string | null
default:start

Sort by a specific field. If not provided, calls will be sorted by start_date.

order_by
string | null
default:desc

Order by a specific field. If not provided, calls will be ordered by start_date in descending order.

filters
string | null
deprecated

Filter calls by a specific field. Format: key=value

fields
string | null

Comma-separated list of call fields to return (e.g. 'call_type,from_number,status').

custom_fields
object

Filter by conversation custom field key-value pairs using bracket notation. Use custom_fields[key]=value to filter on any key in a conversation's custom_fields, the same keys webhook events publish as conversation_custom_fields. Combine several pairs to require all of them: ?custom_fields[rc_id]=RC12345&custom_fields[lead_type]=residential. Dotted keys reach nested custom fields, so custom_fields[order.id]=A17 matches {"order": {"id": "A17"}}. At most 10 pairs per request; keys are limited to 128 characters and values to 256. Values are compared as exact, case-sensitive strings: a custom field stored as the number 12345 is not matched by custom_fields[job_id]=12345.

Response

Successful Response

calls
CallResponse · object[]
required
meta
PaginationModel · object
required