Skip to main content
GET
Export Status

Credits and plans

PAYG is Pay-as-you-go. AYCE is All-you-can-eat.

When to use this endpoint

Follow the exportId returned by Start Export. Reading status does not run another paid retrieval.

Example

Set REVENUEBASE_EXPORT_ID to the exportId returned by Start Export. Use a job created by this API key’s account. Set REVENUEBASE_API_KEY to your API key.

Read the status

Download a completed file

Download only when status is COMPLETED and a downloadUrl is present. Refresh an expired link by reading status again. Repeated downloads and link refreshes do not create another export or add credits. The response does not contain a final charged-credit total.

Errors and retries

An unknown export or one you do not own returns 404. Confirm the ID from the start response. Poll every 5 to 10 seconds and slow down for longer jobs. Contact and company routes share the default 10 requests per second per user. Wait for the reset time or Retry-After when rate limited; coordinate requests across your workers and API keys. Keep polling through FINALIZING. Stop on COMPLETED, ERROR, or CANCELLED. Read error and code before correcting a failed request. Repeating the original start POST creates another job and can charge again.

Next steps

Cancel an unfinished export if you no longer need it. Company files use Company Export Status. Email Verification batches use numeric process_id values and the job endpoints.

Authorizations

X-Key
string
header
required

Path Parameters

export_id
string
required

Export identifier returned by Start Export.

Response

Successful Response

The response is of type Response Export Status V1 Exports Export Id Get · object.