Skip to content

Database search

Check an export

Poll export status from POST /api/v1/contacts/search/export. While job_status is queued or running, retry every few seconds. When completed, the response includes a presigned export_url (valid 24 hours).

GET/api/v1/contacts/search/export/{export_id}

Authorization

HeaderTypeRequiredDescription
X-API-KeystringrequiredYour API key, for example lb_live_YOUR_API_KEY. You can send the same key as Authorization: Bearer instead.

Path parameters

NameTypeRequiredDefaultDescription
export_idstringrequiredThe export id of the record you want.

Response

ok boolean
True when the request succeeded.
export_id string
The identifier of the export job.
job_status string
One of queued, running, completed or failed.
export_url string
A signed CSV download link, valid for 24 hours.
expires_in_seconds number
How long the download link stays valid.
rows_exported number
The number of rows written to the CSV.
rows_available number
The number of rows that matched the filters.
rows_capped_by_credits boolean
True when the credit balance limited the export.
query_credits_used number
Plan credits this request spent.
creditsRemaining number
Plan credits left after this request. Null on unlimited plans.