Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

locationId
string
required

The sub-account. It is the only thing that identifies the tenant on these routes, and it is re-checked against your access on every call. A sub-account that keeps its contacts in a CRM answers 400.

Match a name, an email or part of the phone number.

outcome
enum<string>

Narrow to transferred or not_qualified.

Available options:
transferred,
not_qualified
limit
integer

Page size, 1 to 200. Defaults to 50.

Required range: 1 <= x <= 200
skip
integer

Rows to skip before the page.

Required range: x >= 0

Response

The page, and the size of the whole filtered set.

success
boolean
required
data
object
required
{key}
any