Skip to main content
POST
Fetch companies with corresponding data
The Fetch Company endpoint returns comprehensive data for a given company ID. By default, the response contains basic company info and firmographic data. The fields array accepts the following values:
  • company_info β€” Basic company information and firmographic data (returned by default).
  • tags β€” Tags assigned to the company.
For more details see Models > Company.

Limits

Each identifier array (ids, linkedin_slugs, linkedin_ids) accepts up to 1,000 values per request. Combine arrays freely up to the per-array cap.

Responses

In addition to the standard error responses, this endpoint may return:
  • 402 Payment Required β€” your team’s API credit allowance has been exceeded. Top up or upgrade your plan to continue. See Credits & Usage.

Partner teams

Partners can execute a request in the context of a child team by passing the child team’s ID in the x-authenticate-team header:
  • With the header β€” the fetch runs in the context of the child team (e.g. tag membership reflects the child team).
  • Without the header β€” the fetch runs in the context of the team that owns the API key (default).
The child_team_id is returned when you create a child team.
Example request
Migrating from v2? v3 uses snake_case for all field names. The v2 equivalents were linkedinNames, linkedinIds, notFound, and company_info.Size. See the Migrating to v3 guide.

Authorizations

x-api-key
string
header
required

Headers

x-authenticate-team
string

Partner accounts only. When present, the request is executed in the context of the specified child team (use the team_id returned by Create Team). When omitted, the request runs as the team that owns the API key.

Body

application/json
ids
string<uuid>[]
required

The Swarm company IDs

Maximum array length: 1000
linkedin_names
string[]

LinkedIn company URL slugs

Maximum array length: 1000
linkedin_ids
integer[]

LinkedIn numeric company IDs

Maximum array length: 1000
fields
enum<string>[]
Available options:
company_info,
tags

Response

A list of companies with corresponding data

results
object[]
required

List of companies with corresponding data

not_found
string[]

List of company identifiers (ids / linkedin_names / linkedin_ids) that were not found