Skip to main content
POST
Export people-search results to a CSV file.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json
companyId
string
required

Company ID for access and any applicable data-credit charges

includeEmail
boolean
default:true

Enrich email for 1 data credit per email found.

includePhone
boolean
default:false

Enrich mobile/direct phone for 2 data credits per returned number.

requireEmail
boolean
default:false

Leave out people with no email after enrichment. They count as failed and cost nothing.

requirePhone
boolean
default:false

Leave out people with no phone after enrichment (set includePhone too). They count as failed and cost nothing.

rows
object[]

Selected results, up to 50. Omit to export a filtered search.

filters
object

Search filters; required when rows are omitted.

count
integer

Maximum people to export, from 1 to 50000.

importAll
boolean

Export matching results, capped at 50000.

audienceName
string

Optional label for the job.

importId
string

Optional UUID identifying this job. Reuse it to retrieve the same job when retrying an unchanged request.

Response

Queued export; poll lists_getTaskStatus for result.downloadUrl

The queued background people job

taskId
string

Background task id. Poll lists_getTaskStatus with it until status is completed, failed or cancelled.

listId
string

The destination smart list (null for an export or a sequence import).

sequenceId
string

The destination sequence (null unless importing into a sequence).

status
string

Always "background" — the job runs asynchronously.

message
string

Human-readable status message