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
| Header | Type | Required | Description |
|---|---|---|---|
X-API-Key | string | required | Your API key, for example lb_live_YOUR_API_KEY. You can send the same key as Authorization: Bearer instead. |
Path parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
export_id | string | required | The export id of the record you want. |
Response
okboolean- True when the request succeeded.
export_idstring- The identifier of the export job.
job_statusstring- One of queued, running, completed or failed.
export_urlstring- A signed CSV download link, valid for 24 hours.
expires_in_secondsnumber- How long the download link stays valid.
rows_exportednumber- The number of rows written to the CSV.
rows_availablenumber- The number of rows that matched the filters.
rows_capped_by_creditsboolean- True when the credit balance limited the export.
query_credits_usednumber- Plan credits this request spent.
creditsRemainingnumber- Plan credits left after this request. Null on unlimited plans.