Skip to main content
POST
Search contacts

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string

Structured filter expression. See Query syntax for expression functions. Filterable fields: id, createdAt, updatedAt, firstName, lastName, isSubscribed, labels, notes, groups, phoneNumber, email. Filter custom contact attributes with getBy('attributes', 'name', 'your_attribute_name') or getBy('attributes', 'id', 'attribute-id').

sortBy
string

Sort expression. See Sort By syntax for expression functions. Sortable fields: id, createdAt, updatedAt, firstName, lastName, isSubscribed, labels, notes, groups, phoneNumber, email. Sort custom contact attributes with getBy('attributes', 'name', 'your_attribute_name') or getBy('attributes', 'id', 'attribute-id').

Free-text search by full name (firstName and lastName combined with a space), phone number, or email. See Search.

pagination
object

Page through results. Defaults to page 0 and limit 10 when omitted. See Pagination.

Response

data
object[]
required
pagination
object
required
query
object
required
success
enum<boolean>
required
Available options:
true