Enrich a company

Retrieve the public company record associated with a LinkedIn identifier.

POST /v1/actions/linkedin-extract-company/run/live

Authentication and cost

Use an API key in the Bearer header. This action costs 1 credit per returned record. The maximum result count is 1.

Request

bash

curl "$API_URL/v1/actions/linkedin-extract-company/run/live" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: unique-linkedin-extract-company-001" \
  -H "Content-Type: application/json" \
  -d '{
  "input": {
    "identifier": "https://www.linkedin.com/company/microsoft/"
  },
  "max_results": 1,
  "max_credits": 1
}'

Parameter	Requirement
`input.identifier`	Required non-empty string, at most 500 characters.
`max_results`	Integer from 1 to 1. Default 1.
`max_credits`	Optional positive integer; must cover the requested reservation.
`Idempotency-Key`	Required; 8–128 letters, numbers, underscores, hyphens, or colons.

Output fields

The response contains an output array. Available record fields include:

company_name
linkedin_company_id
linkedin_company_url
linkedin_company_handle
website
domain
industry
description
specialties
number_employees
employees_range
followers_count
locations

Fields not available from the source are omitted. Your parser must tolerate absent properties and empty arrays. Examples are illustrative, not live customer data.

Completion and retries

Both 200 and 202 are valid responses. Read status: a live call can remain queued when capacity is busy. Poll the run until it reaches a terminal state. A terminal failed run can have HTTP 200; inspect its error and status, not just the HTTP code.

Reuse the same idempotency key and request body after a network timeout. A changed request under the same key returns 409.

Coverage notes

Employee counts and size bands are distinct fields. Locations depend on the source. This action does not return the complete employee roster, company affiliates, or follower identities.

See coverage and limits before planning a production dependency. For async execution, replace /run/live with /run/async using the same input.