Exports

Create an export

Builds a CSV of the people who match your filters. Every email is checked when the file is built and you pay only for the ones that pass. Up to 50,000 rows make one file; more become a batch of files. People you exported before are left out by default. Poll the export, then download the CSV.

Every people filter applies, include and exclude alike. A search that leaves people out, limits where keywords look or uses a title match mode, or uses the newer filters (size and revenue ranges, radius, gender or income) is exported up to 50,000 people at a time; for more, save it as a list (it has no limit) and export the list.

Cost	What it does	Key scopes
1 credit per contact whose email passes the check, plus 10 per phone number with include_phones	Spends credits	argorant:create_exports

post/api/v1/exports

Request

Base URL: https://app.argorant.com
URL: https://app.argorant.com/api/v1/exports
Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Request body

limitinteger

Most rows (default 1,000). Above 50,000 the export becomes a batch of files, up to 500,000 rows.

exclude_previously_exportedboolean

Leave out people you exported before (default true).

include_phonesboolean

Add phone numbers, 10 credits each (default false, from the Pro plan).

gradesstring[]

The results to include, valid and catch_all (default both).

email_when_doneboolean

Email you when the file is ready.

Example request

{
  "limit": 500
}

Response

Created

job_idinteger

Export id.

namestring nullable

Your name for the file.

status'queued' | 'processing' | 'done' | 'failed' | 'cancelled'

Where the export is.

progress_pctinteger nullable

Percent done.

limitinteger nullable

Rows asked for.

total_rowsinteger nullable

Rows in the file.

verified_rowsinteger nullable

Rows whose email passed the check.

no_email_rowsinteger nullable

Rows without an email.

grade_countsobject nullable

How many rows got each check result.

downloadableboolean

true when the CSV can be downloaded.

include_phonesboolean

Whether phone numbers were asked for.

exclude_previously_exportedboolean

Whether people exported before were left out.

credits_chargedinteger nullable

Credits charged for this file.

emails_billedinteger nullable

Emails charged.

phones_billedinteger nullable

Phone numbers charged.

error_messagestring nullable

Why it failed, in plain words.

billing_notestring nullable

How the file was charged, in one plain sentence.

batch_idinteger nullable

The batch this file belongs to, for exports above 50,000 rows.

chunk_indexinteger nullable

Its place in the batch.

filtersobject

The filters of the export.

created_atstring date-time nullable

When it was created.

started_atstring date-time nullable

When it started.

completed_atstring date-time nullable

When it finished.

status_urlstring nullable

Path to check the export.

download_urlstring nullable

Path of the CSV download once done.

Changes

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