GET · leads:read

List tasks

List recent tasks owned by the authenticated account. Follow before to read older tasks.

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

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?limit=20" -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.

limit (integer): Optional. 1–50; default 20.
before (string): Optional. Cursor from the last item; an ISO timestamp or timestamp|UUID.

Response

data is an array of task summaries.

Example response

{
  "request_id": "6c4d0c26-8aa3-44b0-a50a-51b832b29465",
  "status": "success",
  "data": [
    {
      "id": "73bd1ccb-1a44-4b41-84da-4ea7a5ad03f4",
      "kind": "agent",
      "status": "running",
      "prompt": "Find 20 dentists in Austin with emails",
      "source": "research-example",
      "max_leads": 20,
      "lead_count": 0,
      "created_at": "2026-10-21T12:00:00+00:00",
      "updated_at": "2026-10-21T12:00:00+00:00",
      "status_url": "/api/v1/tasks/73bd1ccb-1a44-4b41-84da-4ea7a5ad03f4"
    }
  ],
  "meta": {}
}

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

Read as Markdown