API Reference
Retrieve paginated leads captured by your agent. Includes name, email, phone, company, message, and creation date. Requires Plus plan or higher.
/api/v1/agents/{id}/leads
Plus+| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Required | Agent ID (Path) |
| limit | integer | Max leads per page (default: 20, max: 100) | |
| cursor | string | Opaque cursor for next page |
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
}curl -X GET "https://chatspark.io/api/v1/agents/ag_123/leads?limit=20" \
-H "Authorization: Bearer cs_live_..."