API Reference / Filters

GET /filters

Get the list of custom filters (for the logged API user's account)

Returns the account's saved contact filters, each with its name and the conditions that define it — the filter definitions themselves, not the contacts they match. To get matching contacts, use GET /contacts/filters/{filter_id}.

Query parameters

Name Type Description
page integer Page number. Starts from 1. Default is 1.
per_page integer Number of records to return. Maximum 100 allowed. Default is 10.

Responses

200 OK
  • statusintegerint32

    Response code

  • messagestring

    Response message

  • timestampintegerunix-timestamp

    Response time

  • dataobject
    object fields →
    • filtersarray<object>
      array item fields →
      • filterobject

        Allow you to query contacts in your own custom way. These filters can only be created on the website but they can be used through the API.

        object fields →
        • idstringbson-id

          ID of the custom filter

        • namestring

          Name of the custom filter

        • conditionsarray<array<string>>

          Conditions of the custom filter

    • total_countintegerint32

      Total number of items

    • pageintegerint32

      Current page number

    • per_pageintegerint32

      Number of items returned in each page

    • max_pageintegerint32

      The page number of the last page of items

Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.

Related guides