Filter companies by structured criteria
Builds a company segment from company, financial, officer and shareholder
criteria. All top-level criteria must match. Within officers and shareholders,
match decides whether every condition or any condition must hold.
Costs 25 credits per page.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A structured company filter. At least one criterion.
A criterion the data store cannot apply is refused with 400 invalid_request, before anything is charged, rather than answered with a wider or empty page. For now that includes more than one officer or shareholder condition: send one condition per filter.
1 <= propertiesResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/search/companies/filter" \ -H "Content-Type: application/json" \ -d '{ "company": { "status": [ "active" ], "legal_form": [ "gmbh", "ug" ], "industry": [ "62" ], "near": { "latitude": 48.1374, "longitude": 11.5755, "radius_meters": 25000 } }, "officers": { "match": "all", "conditions": [ { "role": [ "managing_director" ], "status": "current", "age": { "gte": 60 } } ] }, "limit": 50 }'{ "object": "search_result", "has_more": true, "next_page": "string", "total_count": 0, "data": [ { "object": "company_summary", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "status": "active", "legal_form": "gmbh", "register": { "court": { "code": "D2601", "name": "Amtsgericht München" }, "type": "HRA", "number": "292661", "formatted": "Amtsgericht München HRB 292661", "country": "DE" }, "city": "string", "registration_date": "2019-08-24", "founding_date": "2019-08-24" } ]}