Chatspark
K

API Reference

v1
K

List Leads

Retrieve paginated leads captured by your agent. Includes name, email, phone, company, message, and creation date. Requires Plus plan or higher.

GET

/api/v1/agents/{id}/leads

Plus+

Parameters

NameTypeRequiredDescription
idstringRequired

Agent ID (Path)

limitinteger

Max leads per page (default: 20, max: 100)

cursorstring

Opaque cursor for next page

Response Schema

json

{
  "leads": [
    {
      "id": 1,
      "name": "Jane Doe",
      "email": "jane@example.com",
      "phone": "+1234567890",
      "companyName": "Acme Inc",
      "message": "Initial message from lead",
      "createdAt": "2026-02-24T12:00:00.000Z"
    }
  ],
  "nextCursor": "2" | null
}

Code Examples

curl -X GET "https://chatspark.io/api/v1/agents/ag_123/leads?limit=20" \
  -H "Authorization: Bearer cs_live_..."

Previous

List Messages

Next

Get Analytics