GET · leads:read

Read account limits

Read account credits, reset time, request limits, key restrictions and permissions.

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/account

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/account" -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.

Key limits can reduce access. They do not add credits or raise plan limits.

Response

data contains the plan, available credits, limits, key_limits and permissions.

Example response

{
  "request_id": "6c4d0c26-8aa3-44b0-a50a-51b832b29465",
  "status": "success",
  "data": {
    "plan": "pro",
    "lead_credits_remaining": 800,
    "lead_credit_limit": 1000,
    "credits_reset_at": "2026-11-01T00:00:00Z",
    "limits": {
      "reads_per_minute": 60,
      "tasks_per_minute": 10
    },
    "key_limits": {
      "max_leads_per_task": 500
    },
    "permissions": [
      "leads:read",
      "leads:write"
    ]
  },
  "meta": {}
}

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

Read as Markdown