People / Export

Get export job status

Cost: FREE - No credits deducted

Returns the current status of a person search export job. Once completed, includes the results_url to download the export results.

get/people/search/async/{jobId}

Request

  • Base URL: https://api.companyenrich.com
  • URL: https://api.companyenrich.com/people/search/async/{jobId}
  • Auth: API key in header Authorization

Path parameters

jobIdstring uuid required

Response

OK

job_idstring uuid

Unique identifier for the person search export job.

status'pending' | 'processing' | 'completing' | 'completed' | 'failed'

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

requested_countinteger

Number of people requested for export.

total_matchinginteger

Total number of people matching the search criteria.

exported_countinteger

Number of people exported in the results.

credits_chargedinteger

Total credits charged for this job.

created_atstring date-time

Timestamp when the job was created.

started_atstring date-time nullable

Timestamp when the job started processing.

completed_atstring date-time nullable

Timestamp when the job completed.

results_urlstring nullable

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

error_messagestring nullable

Error message if the job failed.

Changes

No recorded changes to this operation across all 1 revision of this API.