Request
Response
Your request returns a Job. When a single-company Job reachessucceeded, its result holds the researched fields. For a batch, or to read the same record as an item, use GET /v1/jobs/{job_id}/items. If you requested people, each result also includes leads.
Item response
People returned in leads
Parameters
Send exactly one ofcompany, companies or input_file_id.
Fields to return. See Field descriptions.
Research depth. See Tiers.
If true, finds people at the company and returns them in
leads. If false, researches the company only.If true, requests the full company org chart and includes it in
org_chart when available. If false or omitted, does not request the full chart.If true, scores each researched field from 0 to 100 and includes a justification and source URLs in
enrichment_field_confidence. If false or omitted, does not enable additional field scoring. See Confidence Scoring.HTTPS callback URL. See Outgoing Webhooks.
custom_id on each record to match the result to your own records.
Tiers
For deeper company investigations, use Atlas.
Field descriptions
Specify each output field underfields. Use a description string or an object with description and type.
"The company's primary Instagram profile URL" instead of "social".
Set a type when your code depends on the shape of the value:
See Fields & Type Casting for every type, nested objects and missing values.
Try it
Open the Company Intelligence API Reference playground.
Related
For older requests and options, see Legacy Company Intelligence.