Skip to content

Calls

List calls

GET/v1/calls

List calls, newest first. Filter by lead source, status, disposition, outcome, direction, date range, and duration.

On this page

Headers

AuthorizationstringRequired
ApiKey $ENTROVOX_KEY. Keys are issued per organization.

Query parameters

lead_source_idstring or nullOptional
lead_idstring or nullOptional
directionstring or nullOptional
dispositionstring or nullOptional
call_outcomestring or nullOptional
routing_modestring or nullOptional
Filter by inbound call routing mode: 'agent' or 'forward'.

One ofagentforward

date_fromstring or nullOptional
date_tostring or nullOptional
min_durationinteger or null, min 0Optional
max_durationinteger or null, min 0Optional
outcome_groupstring or nullOptional
Filter by call group: conversations | transferred | callbacks_in | voicemails | all. Expands to a set of call_outcome values; 'all'/unknown applies no outcome filter. Omit for the classic single-outcome behavior.
qstring or null, max 256Optional
Search across calls: matches the lead's name, the call id, and — when the term contains digits — the digit-stripped from/to numbers, over the full filtered set. Selects the offset-paged path.
sort_bystring or nullOptional
Sort column: when=initiated_at, duration=duration_seconds, lead=the displayed lead-name-else-number. Selects the offset-paged path; default 'when'.

One ofwhendurationlead

sort_dirstring or nullOptional
Sort direction for sort_by (default desc). Selects the offset-paged path.

One ofascdesc

offsetinteger or null, 0–1000000Optional
Offset paging. Any of q/sort_by/sort_dir/offset selects the offset-paged path: meta.next_cursor is null and paging is offset+limit against meta.total. Omit all four for the classic cursor path.
cursorstring or nullOptional
Classic cursor paging. Ignored whenever any of q/sort_by/sort_dir/offset is present (the offset-paged path takes precedence).
limitinteger, 1–200Optional

Default 50

Returns

200 OKSuccessful Response

dataarray of objectAlways present
metaobjectAlways present

Errors

  • 403LEAD_SOURCE_NOT_ALLOWED

    The body names a campaign other than the one this key is bound to.

    Retrying will fail the same way. Fix the request, or contact us.

  • 422VALIDATION_ERROR

    A field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.

    Retrying will fail the same way. Fix the request, or contact us.

Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.