Filter contacts

Runs a structured query over the contact attributes. Each item in payload is one condition; query_operator joins it to the next one and is omitted on the last item.

Authentication

api_access_tokenstring

An API key created in Settings > Developer. A user token works too and is useful while you experiment. A key is authorized at the account level: it reaches every inbox, conversation and contact in the account that issued it, and nothing outside that account.

Path parameters

account_idintegerRequired
Your account id.

Query parameters

pageintegerOptionalDefaults to 1

Request

This endpoint expects an object.
payloadlist of objectsRequired

Response

The matching contacts.
payloadlist of objectsOptional
metaobjectOptional

Errors

401
Unauthorized Error
422
Unprocessable Entity Error