Skip to main content
GET
Get Export Job Status

Authorizations

Authorization
string
header
required

Bearer token obtained by authenticating with your organization's service account credentials (client_id and client_secret).

See the Getting started page for the full authentication flow.

Headers

X-Org-Name
string | null

Name of the organization to scope the request to. This header is required in multi-tenant deployments.

Organization name used to resolve the tenant context.

X-API-Version
string
default:v1

The API version to use. Set to v1. API version to target for this request.

Path Parameters

job_id
string<uuid>
required

UUID of the export job to query.

Identifier of the export job.

Example:

"<uuid>"

Response

Request succeeded and the export job status is returned.

Response containing the state of a bulk export job and, when complete, its download URL.

created_at
string<date-time>
required
Example:

"<timestamp>"

id
string<uuid>
required
Example:

"<uuid>"

org_id
string<uuid>
required
Example:

"<uuid>"

status
string
required

Current status of the export job (for example, pending, running, completed, or failed).

completed_at
string<date-time> | null

Time when the export job finished processing, if it has completed.

Example:

"<timestamp>"

download_url
string | null

URL to download the exported data in JSON Lines format, present when the job has completed successfully.

error_message
string | null

Error message describing why the export job failed, if applicable.

progress
integer | null

Approximate completion percentage for the export job, in the range 0–100.

total_records
integer | null

Total number of records included in the export, when known.