Skip to main content
POST
Create export job

Authorizations

Authorization
string
header
required

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

Query Parameters

expand
enum<string>[]

Expandable response fields. Repeat the parameter to request multiple expansions.

Supported values:

  • workforce: costs 5 credits per company and adds the workforce field to CompanyInfo.
Available options:
workforce

Body

application/json
count
integer<int32>
required

The number of companies to export.

Required range: 1 <= x <= 1000000
webhook_url
string<uri> | null

The webhook URL to receive the notification when processing completes.

Maximum string length: 2048
search
object | null

The filters to be applied on the companies

similar
object | null

The filters used to find similar companies

Response

OK

job_id
string<uuid>

Unique identifier for the search export job.

status
enum<string>

Current status of the job (pending, processing, completing, completed, failed).

Available options:
pending,
processing,
completing,
completed,
failed
requested_count
integer<int32>

Number of companies requested for export.

total_matching
integer<int32>

Total number of companies matching the search criteria.

estimated_credits
integer<int32>

Estimated credit cost for the export job.