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.

campaignId
string

Restrict results to the leads one campaign dialled. Resolved against call records, so the count matches the campaign figures on the dashboard. Only V2 activity carries campaign attribution.

masterCampaignId
string

Restrict results to the leads an entire master campaign dialled, across every linked project the caller can see. A master campaign is fanned out into one child campaign per project, each with its own id, so filtering by a single campaignId returns one project's share of it. Mutually exclusive with campaignId: the two are contradictory scopes rather than narrowing ones, and sending both is a 400.

agentVariantId
string

Restrict results to one Agent Variant inside a split test. Requires campaignId and cannot be combined with masterCampaignId: a variant id only identifies a variant within its own campaign, so an unscoped one has no meaning and is rejected.

projects
string

Optional display labels accompanying locationIds. Names alone cannot select projects.

locationIds
string

Canonical Location IDs for selecting multiple projects. Names are labels only and cannot identify the selection.

Name, phone or contact id. Names match from word starts.

dateFromUTC
string

Inclusive UTC lower bound for contact creation time. 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 upper bound for contact creation time. 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.

disposition
enum<string>[]

Outcome filter. Send it repeated (disposition=appointment&disposition=callBack) or comma-joined (appointment,callBack) to match several.

Available options:
killSwitch,
callBack,
appointment,
liveTransfer,
failedTransfer,
tagged
internal
enum<string>

How to treat contacts marked as your own test leads. all (the default) lists them alongside everything else with isInternal set on each row, only narrows to just those, exclude hides them. They are listed by default because hiding them would leave no way to find one and undo the mark.

Available options:
all,
only,
exclude
page
integer

Page number, starting at 1.

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

Contacts per page.

Required range: 1 <= x <= 500
sortBy
enum<string>

Sort field.

Available options:
leadName,
phoneNumber,
projectName,
dateAdded,
callCount
sortOrder
enum<string>

Sort direction.

Available options:
asc,
desc

Response

Contacts page returned successfully.

success
boolean
required
data
object
required