Skip to main content
POST
Export a company search asynchronously

Authorizations

Authorization
string
header
required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Body

application/json
limit
integer<int32> | null
required

The maximum number of search results to export. Results whose company is no longer available are skipped, so an export can return fewer companies. Your plan's search limit also applies.

Required range: 1 <= x <= 1000000
expand
enum<string>[] | null

Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:

  • financial: 1 credit
  • keywords: 1 credit
  • naicsCodes: 1 credit
  • technologies: 1 credit
  • workforce: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from GET /v2/companies/workforce costs another 1 credit.
Available options:
financial,
keywords,
naicsCodes,
technologies,
workforce
filter
object | null

The filters to apply to the company search

semantic
object | null

The semantic query used to find relevant companies

lookalike
object | null

The seed companies used to find lookalike companies

Response

Accepted

id
string<uuid>
required

The batch ID.

kind
string
required

The task represented by the batch.

status
enum<string>
required

The current batch state.

Available options:
pending,
running,
completed,
cancelling,
cancelled
progress
object
required

The number of requests in each state.

creditsCharged
number<double>
required

The credits charged so far, in user-visible credits.

createdAt
string<date-time>
required

When the batch was created.

statusUrl
string
required

The authenticated URL for checking batch status and progress.

resultsUrl
string
required

The download URL for the task's projected results. It is signed, so it works without credentials for one hour; after that, use the owner's credentials or a URL from a new status response.

rawResultsUrl
string
required

The download URL for raw HTTP outcomes in NDJSON format, signed like resultsUrl.

recordCount
integer<int32> | null

For a search export, the number of records its settled pages returned.

recordLimit
integer<int32> | null

For a search export, the most search results it requests. Results whose record is unavailable are skipped, so recordCount can end below it.

completedAt
string<date-time> | null

When the batch completed or was cancelled, if terminal.