Create Company Enrichment
/v2/companies/enrichmentsStarts a job that matches up to 10,000 companies (by LinkedIn URL, domain or name) against GetProspect. Free: no credits. The job runs at once and the answer carries no estimate: poll it at Location (GET /v2/jobs/{id}) or read it at GET /v2/enrichments/{id}, or subscribe once to job.finished with POST /v2/webhooks. A row with none of the three is accepted and counted under counts.invalid. At most 5 enrichments are active per workspace. With an Idempotency-Key, a retry answers the job it created. 1 jobs rate-limit unit.
How are credits spent?
Company enrichment jobs are free.
How the job works
Send up to 10,000 rows, the same items as
Company Bulk Enrich without id and
linkedin_id (domain, name or linkedin_url), each with an optional
identifier of yours. The answer is 202 with the job and
Location: /v2/jobs/{id}; the job is already running. A row with no usable
lookup is kept and reported as invalid.
Poll the job or subscribe to job.finished, then page the results with
Get Enrichment Results: one item per row in
request order, matched rows with the same company object the sync bulk
enrich returns. See Bulk jobs: poll or webhook.
Body parameters
namestringoptionalmax length: 128A label for the job.
dataobject[]requiredArray of company lookup rows (1-10000). Each row is matched independently.
Field Type Description identifierstring Client-supplied correlation key echoed back with the row result. If omitted, the row index is used. max length: 128. linkedin_urlstring The LinkedIn company URL. max length: 512. domainstring The company domain. max length: 512. namestring The company name. max length: 512.
Responses
For error handling see Errors. Response objects are described in Person object and Company object.
