Skip to main content
GET
Get export job status

Authorizations

Authorization
string
header
required

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

Path Parameters

jobId
string<uuid>
required

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.

exported_count
integer<int32>

Number of companies exported in the results.

credits_charged
integer<int32>

Total credits charged for this job.

created_at
string<date-time>

Timestamp when the job was created.

started_at
string<date-time> | null

Timestamp when the job started processing.

completed_at
string<date-time> | null

Timestamp when the job completed.

results_url
string | null

URL to download the search export results (available when completed).

error_message
string | null

Error message if the job failed.