Skip to main content

Overview

The Filter Options API returns the available values for one or more specific filter fields used by the List Generation API. Pass the filter field names you’re interested in — the same field values returned by the Get Filters List API — and get back the options available for each one. Use this endpoint after calling Get Filters List: once you know which filter fields exist, use this endpoint to populate a dropdown, autocomplete, or picker with the actual selectable values for a given field, rather than hardcoding them. This is a free endpoint so it does not consume API credits. Endpoint

Authentication

All requests must include an API key in the x-api-key HTTP header.
Never expose your API key in client-side code, browser requests, or public repositories. A missing or invalid key returns 401 Unauthorized.

Request

Body parameter

To fetch options for a single filter, pass one object in dropdowns. To fetch options for every filter in one call, pass one object per filter field. Example request — single filter:
Example request — multiple filters at once:

Response

Response envelope