Overview
This page documents thefilters JSON shape supported by semantic and lookalike search.
Prerequisites
Endpoints used
- Search endpoint (
GET /v1/companies/search) - Lookalike endpoint (
GET /v1/companies/:company_identifier/similar) - Search endpoint (
POST /v1/companies/search) - Lookalike endpoint (
POST /v1/companies/:company_identifier/similar)
Filters shape
On theGET endpoints, send filters as a JSON string (URL-encoded). On the POST endpoints, send filters as a native JSON object in the request body.
range.founded.max shown here is an example value, not a product limit.
Supported fields
| Field path | Type | Meaning |
|---|---|---|
include.size | string[] | Keep these company size buckets. |
include.country | string[] | Keep these countries. |
include.city | string[] | Keep these cities. |
exclude.size | string[] | Remove these company size buckets. |
exclude.country | string[] | Remove these countries. |
exclude.city | string[] | Remove these cities. |
exclude.domains | string[] | Remove companies by domain or URL (normalized server-side, alias-aware, max 1000). |
range.founded.min | integer | Keep companies founded on/after year. |
range.founded.max | integer | Keep companies founded on/before year. |
exclude.domains accepts company domains or full URLs; each is normalized to its registered domain, so https://www.stripe.com/pricing, stripe.com, and blog.stripe.com all exclude stripe.com. A large exclusion list does not fit a GET URL — use the POST endpoints for lists beyond a few hundred domains.
Supported size values
Use exact values:1-1011-5051-200201-500501-10001001-50005001-1000010001+
Copy-paste request example
exclude.domains list, POST filters as a JSON object instead:
Troubleshooting
422 Unprocessable Entity
The filters JSON is malformed or includes unsupported keys.
Validate your filters JSON before sending: echo '<filters-json>' | jq empty.
Filter returns no results
Start broad, then narrow one filter dimension at a time. Remove all but one filter group (include, exclude, or range) and re-run to find the limiting condition.