docs sourcing
Lookups
Resolve places, areas, companies, and filter values before you search.
Raw filters take ids, not free text. Lookups turn names into those ids. Guided runs do this for you; raw search needs it.
| Call | Returns | Use in |
|---|---|---|
GET /v1/lookups/locations?q=Ghent&prefer_area=true | Location ids, best first | geo_ids, exclude_geo_ids |
GET /v1/lookups/areas?anchors=Ghent&radius_km=30 | Every known city and area within the radius | geo_ids |
GET /v1/lookups/companies?q=show | Companies from the built-in list | current_companies, past_companies |
POST /v1/companies:resolve | Company URLs for any names, up to 50 | current_companies, past_companies |
GET /v1/lookups/industries | Industry ids | industry_ids |
GET /v1/lookups/functions | Job function ids | function_ids |
GET /v1/lookups/seniorities | Seniority level ids | seniority_level_ids |
GET /v1/lookups/experience-ranges | Year buckets 1–5 | years_of_experience_ids, years_at_current_company_ids |
GET /v1/lookups/headcounts | Company size ranges A–I | company_headcount |
GET /v1/lookups/languages | Profile language codes | profile_languages |
The value lists take q to filter by label.
Places
UK is the United Kingdom. Do not invent a location id: raw search refuses a non-numeric geo_ids entry with a free 400. prefer_area=true picks the metropolitan area over the city when both exist.
anchors takes several places (repeat the parameter or separate with |). radius_km is 10 to 100, default 30. Nearby places come from a built-in city table; a place without coordinates contributes only itself, and note says so.
Companies
GET /v1/lookups/companies searches the built-in list only and is free. POST /v1/companies:resolve handles any name or company URL, with an optional country to disambiguate common names. It is a paid call: ?dry_run=true shows how many names need a live lookup, and executing needs an Idempotency-Key.
What it costs
Location lookups for known places, areas, the built-in company list, and every value list are free. An unknown place costs one lookup the first time and is cached for everyone. companies:resolve costs 1 credits per new company found; known, cached, and unknown companies are free.
Reference: the Building blocks tag in the API reference.