Skip to main content
POST
Look up contacts

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Query Parameters

limit
integer
default:20

Page size, 1 to 100. Out-of-range values are clamped and the value used is echoed in pagination.limit. A value that is not a whole number, such as abc or 1.5, is rejected with 400 VALIDATION.INVALID_PARAMETER.

Example:

20

cursor
string

Opaque cursor from a previous page's pagination.next. Pass it back unchanged. Send the same body as the request that returned it. A cursor this API did not issue, or one sent with a different body, is rejected with 400 PAGINATION.INVALID_CURSOR.

Body

application/json

Send at least one of phones and emails.

phones
string[]

Up to 50 numbers in E.164.

Maximum array length: 50
emails
string[]

Up to 50 addresses. Matched without regard to case.

Maximum array length: 50
type
enum<string>

Default: both.

Available options:
contact,
lead

Response

One page of matching contacts.

data
object[]
required
pagination
object
required
requestId
string
required