Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

projectName
string

Optional display label alongside locationId. It never identifies a tenant; selecting by name alone returns 400.

locationId
string

Location ID of the project to read. Required when selecting a project; omit every project selector for an agency-wide read. Project names are labels only and never select a project on their own.

status
string

Filter by call status. Multiple values may be comma-separated.

direction
enum<string>

Filter by call direction.

Available options:
inbound,
outbound
agent
string

Filter by agent display name.

campaignId
string

Filter by campaign id.

agentVariantId
string

Restrict results to the calls one Agent Variant placed. Requires campaignId; sending it without one is rejected, because a variant id only identifies a variant within its own split test.

dateFromUTC
string

Inclusive UTC start of the call window. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and read as that day at 00:00:00Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window.

dateToUTC
string

Inclusive UTC end of the call window. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and covers that whole day, through 23:59:59.999Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window.

tz
string

IANA time zone, such as America/Los_Angeles, that a plain YYYY-MM-DD bound is read in: the window then runs from that day's local midnight to the next, across daylight-saving changes. Bounds with a time are exact instants and are not affected. When it is missing or not a known zone, plain dates are UTC days.

durationMin
integer

Minimum call duration in seconds.

Required range: x >= 0
durationMax
integer

Maximum call duration in seconds.

Required range: x >= 0
phoneNumber
string

Search by lead phone number.

leadName
string

Search by lead name. Each word matches the start of a word in the lead's name, in any order.

callId
string

Find the call with this call id.

contactId
string

Find the calls with this contact id.

excludeReviewed
boolean

When true, exclude calls already reviewed in QA workflows.

disposition
string

Comma-separated outcome filters.

page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:50

Page size.

Required range: 1 <= x <= 200
sort
enum<string>
default:dateTime.desc

Sort as field.direction.

Available options:
dateTime.desc,
dateTime.asc,
status.desc,
status.asc,
duration.desc,
duration.asc,
projectName.desc,
projectName.asc

Response

Paginated call records.

success
boolean
required
data
object
required