Skip to main content
POST
Filter Options API

Overview

The Get Filter Options API returns the selectable values for one or more filter fields, given a list of dropdown_type names. Pass the filter field names — the same field values returned by the Get Filters List API — and get back the options available for each one. This is a free endpoint and does not consume credits. Results are returned in the API response.

Endpoint Details

  • Method: POST
  • Endpoint: /api/v1/filters/options/

Authentication requirements

  • Include a valid API key in the x-api-key request header.

Request

Request Parameters

Body Parameters

object[]
required
Array of objects, one per filter you want options for. Each object has a single dropdown_type key — a filter field name from the Get Filters List API (e.g. firmographic.company_type).To fetch options for every filter in one call, pass one object per filter field:

Example Request

Response

Successful Response Fields

Returns a JSON object with the following structure:
object
Options keyed by the dropdown_type requested. Each value is an array of option objects for that filter. See Option Object below.
float
Credits consumed by the request. This endpoint is free and always returns 0.00.

Option Object

string
The value to pass in filters when calling the List Generation API.
string
Human-readable label for the value, suitable for displaying in a UI dropdown.