Sign in
calls

List Calls

get/calls/

Query parameters

environment'production' | 'staging'

Environment an agent (and the conversations it handles) belongs to.

Vestigial since the staging clone was removed: every agent and every new conversation is PRODUCTION. The column is retained because historical rows still carry it and several snapshot filters key off it.

Filter by environment. Defaults to production.

was_transferredboolean nullable
transfer_failedboolean nullable

Filter to calls where transfer attempts were made and every attempt failed.

Filter to calls where transfer attempts were made and every attempt failed.

was_missedboolean nullable
was_answeredboolean nullable
is_voicemailboolean nullable
transfer_destinationstring nullable
transfer_failure_reasonstring nullable

Filter to unreached calls whose transfer failed for this reason (no_answer / busy / declined / no_agent_available / line_error).

Filter to unreached calls whose transfer failed for this reason (no_answer / busy / declined / no_agent_available / line_error).

contact_sourcestring nullable
outcome'voicemail' | 'missed_by_system' | 'transferred' | 'handled_end_to_end' nullable

Outcome bucket filter

Outcome bucket filter

has_first_responseboolean nullable

Filter to calls where the AI produced a first response (population behind the avg-first-response widget).

Filter to calls where the AI produced a first response (population behind the avg-first-response widget).

has_endedboolean nullable

Filter to calls that have ended (population behind the avg-resolution-time widget).

Filter to calls that have ended (population behind the avg-resolution-time widget).

local_hour_of_dayinteger nullable

Filter to calls stamped at this tenant-local hour (0-23); heatmap cell drill.

Filter to calls stamped at this tenant-local hour (0-23); heatmap cell drill.

local_day_of_weekinteger nullable

Filter to calls stamped on this tenant-local weekday (0=Mon..6=Sun); heatmap cell drill.

Filter to calls stamped on this tenant-local weekday (0=Mon..6=Sun); heatmap cell drill.

bucketsstring[] nullable

Filter to calls in any of these attribution buckets — the drill of a bucket-grouped cell or a bucket filter.

Filter to calls in any of these attribution buckets — the drill of a bucket-grouped cell or a bucket filter.

dispositionsstring[] nullable

Filter to calls in any of these terminal dispositions — the drill of a disposition-set measure (e.g. Missed & Abandoned).

Filter to calls in any of these terminal dispositions — the drill of a disposition-set measure (e.g. Missed & Abandoned).

needs_owner_reviewboolean nullable

When true, returns only calls where a human participated but the outcome owner is not credited to a human (unattributed worklist).

When true, returns only calls where a human participated but the outcome owner is not credited to a human (unattributed worklist).

use_created_atboolean nullable

Deprecated - use date_field=created_at.

Deprecated - use date_field=created_at.

failed_transfer_destinationstring nullable

Filter to calls that had a FAILED transfer attempt to this destination (the drill target of the Failed Transfer Attempts widget).

Filter to calls that had a FAILED transfer attempt to this destination (the drill target of the Failed Transfer Attempts widget).

failed_transfer_tool_namestring nullable

Filter to calls that had a FAILED transfer attempt via this transfer tool (drill target of the by-Transfer-Target breakdown).

Filter to calls that had a FAILED transfer attempt via this transfer tool (drill target of the by-Transfer-Target breakdown).

attempted_transfer_destinationstring nullable

Filter to calls that ATTEMPTED a transfer to this destination (any outcome). Drill target of the Calls by Transfer Destination count bar.

Filter to calls that ATTEMPTED a transfer to this destination (any outcome). Drill target of the Calls by Transfer Destination count bar.

attempted_transfer_tool_namestring nullable

Filter to calls that ATTEMPTED a transfer via this transfer tool (any outcome). Drill target of the by-Transfer-Target count bar.

Filter to calls that ATTEMPTED a transfer via this transfer tool (any outcome). Drill target of the by-Transfer-Target count bar.

succeeded_transfer_destinationstring nullable

Filter to calls that SUCCEEDED (reached a human) via this destination. Drill target of the transfer_calls 'Reached' segment.

Filter to calls that SUCCEEDED (reached a human) via this destination. Drill target of the transfer_calls 'Reached' segment.

succeeded_transfer_tool_namestring nullable

Filter to calls that SUCCEEDED (reached a human) via this transfer tool. Drill target of the by-Transfer-Target 'Reached' segment.

Filter to calls that SUCCEEDED (reached a human) via this transfer tool. Drill target of the by-Transfer-Target 'Reached' segment.

unresolved_transfer_destinationstring nullable

Filter to calls that attempted this destination but NEVER succeeded here. Drill target of the transfer_calls 'Not reached' segment.

Filter to calls that attempted this destination but NEVER succeeded here. Drill target of the transfer_calls 'Not reached' segment.

unresolved_transfer_tool_namestring nullable

Filter to calls that attempted this transfer tool but NEVER succeeded here. Drill target of the by-Transfer-Target 'Not reached' segment.

Filter to calls that attempted this transfer tool but NEVER succeeded here. Drill target of the by-Transfer-Target 'Not reached' segment.

limitinteger nullable
offsetinteger nullable
pageinteger nullable

Deprecated - use offset.

Deprecated - use offset.

per_pageinteger nullable

Deprecated - use limit.

Deprecated - use limit.

start_datestring date nullable
end_datestring date nullable
date_fieldstring nullable

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

date_fromstring date-time nullable

Deprecated - use start_date.

Deprecated - use start_date.

date_tostring date-time nullable

Deprecated - use end_date.

Deprecated - use end_date.

property_idsstring[] nullable
property_ids_excludestring[] nullable
include_considered_hotelsboolean nullable

Include hotels the conversation was only considered for, not just the one it was attributed to.

Include hotels the conversation was only considered for, not just the one it was attributed to.

agent_idstring uuid nullable
outcome_agent_refstring nullable
outcome_agent_refsstring[] nullable
outcome_agent_refs_excludestring[] nullable
outcome_agent_kind'ai_voice' | 'ai_text' | 'human' nullable
reviewedboolean nullable
statusstring nullable
has_booking_intentboolean nullable
has_bookingboolean nullable
booking_madeboolean nullable
booking_attributedboolean nullable
tag_idsstring[] nullable
countrystring nullable
is_after_hoursboolean nullable
population_filtersstring[] nullable

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

searchstring nullable
standard_filtersstring nullable
metric_filtersstring nullable
sort_bystring nullable
sort_order'asc' | 'desc' nullable
strictboolean

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

voice_agent_idstring uuid nullable

Deprecated - use agent_id.

Deprecated - use agent_id.

metric_idstring uuid nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

metric_state'pass' | 'fail' | 'na' | 'not_run' | 'error' nullable

Deprecated - use metric_filters.

Deprecated - use metric_filters.

booking_intentboolean nullable

Deprecated - use has_booking_intent.

Deprecated - use has_booking_intent.

Response

Successful Response

totalinteger required

Rows matching the filters, in total_units.

limitinteger required

Page size actually applied.

offsetinteger required

Rows skipped.

has_moreboolean required

Whether another page exists.

total_unit'logical_call' | 'row'

What total counts. row for text, email and bookings. voice returns logical_call, because a transferred call is several legs in items but one call in total — so a caller that counts items will legitimately disagree with total.

applied_filtersstring[]

Filters that were compiled into the query.

pageinteger nullable

Deprecated — derive from offset/limit.

per_pageinteger nullable

Deprecated — use limit.

Changes

No recorded changes to this endpoint across all 1 revision of this API.