Get Filter Options

The filter keys and allowed values for Lead Finder searches.

GEThttps://api.foxreach.io/api/v1/lead-finder/filter-options

Requires an API key with the read scope.

Call this before searching. It lists every valid filter key with a one-line meaning, plus the closed vocabularies for industries and company types. It does not check your plan or spend anything.

Response#

dataobject

Filter vocabularies.

Show data

industriesarray

Industry names the provider matches.

companyTypesarray

Company types, for example Privately Held.

headcountGrowthTimespansarray

Values for headcountGrowthTimespan on company searches.

allowedCountriesarray

Alpha-2 codes searches may target. Empty means anywhere that is not blocked.

blockedCountriesarray

Alpha-2 codes that are never shown.

coveragestring

Where results come from, in words.

personFilterKeysobject

Every valid people-filter key mapped to what it does.

companyFilterKeysobject

Every valid company-filter key mapped to what it does.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`
`404`	`Lead Finder is not enabled` while Lead Finder is switched off on this environment
`503`	`Lead Finder is not configured` when it is enabled but has no data provider key

Rate Limit#

100 requests per minute, per API key. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (unix epoch seconds).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Request

curl -X GET "https://api.foxreach.io/api/v1/lead-finder/filter-options" \
  -H "X-API-Key: otr_your_key"

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
options = client.lead_finder.filter_options()

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const options = await client.leadFinder.filterOptions();

Response

{
  "data": {
    "industries": ["Computer Software", "Marketing & Advertising"],
    "companyTypes": ["Privately Held", "Public Company"],
    "headcountGrowthTimespans": ["6months", "12months", "24months"],
    "allowedCountries": [],
    "blockedCountries": ["DE", "FR"],
    "coverage": "every country",
    "personFilterKeys": {
      "jobTitles": "Current job title, e.g. Founder, CEO (include)",
      "countries": "Alpha-2 country codes for where the person is"
    },
    "companyFilterKeys": {
      "names": "Company name (include)",
      "minHeadcount": "Minimum headcount"
    }
  }
}

Was this page helpful?

View as MarkdownLast updated November 2, 2026