Sign in
latestOpenAPI 3.0.32026-08-20147323331.7 KB

a7231589e927

contacts

Search for contacts by a given filter

Filterable fields and their allowed operators:

FieldAllowed operators
idequals, in, not_in
emailequals, in, not_in, string_contains
nameequals, in, not_in, string_contains
account_idequals, in, not_in

For custom fields, pass the field slug as field.

Rate limit: 20 requests per minute

post/contacts/search

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of contacts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

search_textstring

Fuzzy text search. Results are intersected with any provided filter.

Example request

{
  "filter": {
    "subfilters": [
      {
        "field": "state",
        "operator": "equals",
        "value": "new"
      }
    ]
  }
}

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": [
    {
      "custom_fields": {
        "role": {
          "value": "admin"
        }
      }
    }
  ]
}