GET · leads:read

Export results

Download every saved lead for a task as CSV or JSON.

Set up with your AI assistant

Paste the prompt into your coding assistant. It includes setup steps and a read-only connection check.

Request

Endpoint

GET https://leadsagent.io/api/v1/tasks/{id}/export

Set LEADSAGENT_API_KEY in your local environment. Send it in the X-API-Key header.

Bash · API base URL

export LEADSAGENT_API_BASE="https://leadsagent.io/api/v1"
# For a local backend:
# export LEADSAGENT_API_BASE="http://127.0.0.1:8001/api/v1"

Bash · curl

curl --fail-with-body --silent --show-error --request GET "$LEADSAGENT_API_BASE/tasks/$TASK_ID/export?format=csv" -H "X-API-Key: $LEADSAGENT_API_KEY"

Replace TASK_ID with data.id from a task response. In PowerShell, use curl.exe and $env:LEADSAGENT_API_KEY. Save JSON in a file and pass --data-binary @request.json.

id (UUID): Required. The task ID.
format (string): Optional. csv (default) or json.

Export streams the full file. It does not use the paginated results envelope.

Response

HTTP 200 file stream. The default is CSV; choose json for a JSON array.

Example response

HTTP/1.1 200 OK
Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="leads-{task_id}.csv"

[CSV file body omitted]

Errors and retries explains status codes and retry rules. A successful request does not mean a background task has finished.

Read as Markdown

← API reference