Skip to main content
POST
Queue selected rows or a bounded filtered search for CSV export.

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 person.

includePhone
boolean
default:false

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

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.

importId
string

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

Response

Queued export; download link is emailed

The queued background people job

taskId
string

Background task id for the running import.

listId
string

The destination smart list.

status
string

Always "background" — the import runs asynchronously.

message
string

Human-readable status message