Skip to main content
POST
Search contacts
The filter is a list of or groups, each holding and rules. A contact matches when every rule in at least one group matches it.

Matching rules

  • contacts_email_in matches the full address and ignores letter case.
  • contacts_phone_number_in compares digits only, so +, spaces, and dashes don’t affect the match.
  • In email and phone values, * turns the entry into a partial match: *@open.cx finds every address containing @open.cx.
  • contacts_attributes_in matches custom data on an exact key and value. Each object in attributes is one alternative; a contact matches when it carries every key-value pair of any one object.

Pagination

Each page returns up to 250 contacts. When more results exist, the response carries a next value; send it as cursor in the next request with the same filter. next is null on the last page.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
filter
object
required
cursor
string

Pagination cursor to fetch the next set of results

Response

Default Response

items
object[]
required
next
string | null
required