Exports

Get an export

Where an export is. When status is done, download the CSV.

Cost	What it does	Key scopes
Free	Reads only	argorant:create_exports

get/api/v1/exports/{job_id}

Request

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

Path parameters

job_idinteger required

The export id from create or list.

Headers

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.

Response

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.