Sign in
latestOpenAPI 3.0.32026-08-15138306314.9 KB

cfd9e65e79bb

accounts

Search for accounts by a given filter

Optionally pass search_text for fuzzy matching. Results are intersected with any provided filter.

Filterable fields and their allowed operators:

FieldAllowed operators
idequals, in, not_in
domainscontains, does_not_contain, in, not_in
tagscontains, does_not_contain, in, not_in
nameequals, in, not_in, string_contains
external_idsequals, in, not_in, is_set, is_unset
owner_idequals, in, not_in, is_set, is_unset

For custom fields, pass the field slug as field.

Rate limit: 20 requests per minute

post/accounts/search

Request body

cursorstring

The cursor to use for pagination.

limitinteger

The number of accounts 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.

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": [
    {
      "channels": [
        {
          "mirror_to": {
            "source": "slack"
          },
          "source": "slack"
        }
      ],
      "type": "customer"
    }
  ]
}