People / Export

Create export job

Cost: 2 credits per person returned (reserved when the job is created, settled on completion)

Creates an asynchronous search export job for up to 50,000 people. Returns a job ID immediately. The webhook URL will be called with a notification when processing completes.

Use the status endpoint to track progress and retrieve results.

post/people/search/async

Request

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

Query parameters

expandstring[]

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

Supported values:

  • education: costs 1 credit per person and adds the education field to PersonInfo.

Request body

countinteger required

The number of people to export.

webhook_urlstring uri nullable

The webhook URL to receive the notification when processing completes.

querystring nullable

The search query to apply on the company name and domain

positionQuerystring[] nullable

The list of search queries to apply on the person's current job position/title

atCurrentCompanyAfterstring date-time nullable

Filter by current company join date - only include people who joined after this UTC date

atCurrentCompanyBeforestring date-time nullable

Filter by current company join date - only include people who joined before this UTC date

atCurrentPositionAfterstring date-time nullable

Filter by current position start date - only include people who started after this UTC date

atCurrentPositionBeforestring date-time nullable

Filter by current position start date - only include people who started before this UTC date

countriesstring[] nullable

The 2 letter country codes to filter by

domainsstring[] nullable

The domains to find people for. Up to 2,500 domains are allowed.

seniorityPersonSeniority[] nullable

The seniorities to filter by

departmentPersonDepartment[] nullable

The departments to filter by

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.

estimated_creditsinteger

Estimated credit cost for the export job.

Changes

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