Skip to main content
GET
List contacts

Authorizations

x-api-key
string
header
required

Query Parameters

[limit]
integer

How many records to return, at most 250.

Required range: 1 <= x <= 250
[offset]
integer

How many records to skip.

Required range: x >= 0
[project]
string

Comma-separated list of fields to return, e.g. id,createdAt.

Minimum string length: 1
[with]
string

Comma-separated list of relations to populate.

Minimum string length: 1

Free-text search across the contact fields.

Minimum string length: 1
fieldFilters
string

Conditions on field values, as a JSON array of { fieldId, fieldType?, operator, value? }, all of which must hold. Operators: equals, not_equals, contains, not_contains, gt, gte, lt, lte, between (from|to), is_true, is_false, is_empty, is_not_empty. A CONTACT:PHONE equals matches the number with or without the Brazilian ninth digit. Ignored by search.

Minimum string length: 1

Response

Success

data
object[]
required
hasMore
boolean
required
limit
number
required
offset
number
required
total
number
required