Sign up for free
View as Markdown

Company Enrich

POST/v2/companies/enrich

Retrieve the full profile of one company - industry, headcount, locations, domains and LinkedIn data. Look it up by GetProspect id, LinkedIn id or URL, web domain, or name; when several identifiers are sent the strongest wins (id, then linkedin_id, linkedin_url, domain, name). When no company matches, the answer is still 200, with data null and a NOT_FOUND entry in errors. Free: spends no credits; 1 unit of the enrich rate limit, none for a company your workspace saved. Authenticate with your API key in the x-api-key header.

How are credits spent?

Company Enrich is free - matching and returning a company profile never charges credits.

How matching works

Provide any identifier you have inside data. They are tried in order of reliability - id, then linkedin_id, linkedin_url, domain, and finally name - and the first one that finds a company wins. The id and LinkedIn lookups are exact; the name lookup is the fuzziest, so prefer the domain when you have both.

When nothing matches, the 404 response lists which identifiers were attempted, so you can tell a bad input from a genuinely unknown company.

What you get back

A full Company object. To fetch the people who work there, pass the returned id to People Search's company.id filter.

Body parameters

  • dataobjectrequired

    Lookup identifiers. Provide at least one of id, linkedin_id, linkedin_url, domain, or name.

    FieldTypeDescription
    idstringThe GetProspect company id, as returned by Company Search and in People Search results.
    linkedin_idone ofThe LinkedIn company ID (numeric, accepted as string or number), e.g. 2491343.
    linkedin_urlstringThe LinkedIn company URL (e.g. "https://linkedin.com/company/stripe").
    domainstringThe company domain (e.g. "stripe.com").
    namestringThe company name (e.g. "Stripe").

Responses

  • 200 The company, and in metadata.matched_by the key that found it. When none matched, success is false, data is null and errors[0].name is NOT_FOUND, with the keys tried in payload.attempted.
  • 400 Invalid request (VALIDATION_ERROR; payload.code says which kind of mistake).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 429 Over the enrich rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced.
  • 500 Unexpected server error.

For error handling see Errors. Response objects are described in Person object and Company object.