Skip to main content
GET
/
get-leads
Get leads for a chatbot
curl --request GET \
  --url https://www.chatbase.co/api/v1/get-leads \
  --header 'Authorization: Bearer <token>'
{
  "collectedCustomers": [
    {
      "id": "lead_123",
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+1234567890",
      "created_at": "2024-01-01T12:00:00Z",
      "chatbot_id": "ckl123abc456",
      "account_id": "acc_123abc456"
    }
  ]
}

Authorizations

Authorization
string
header
required

API key in Bearer token format

Query Parameters

chatbotId
string
required

ID of the chatbot

startDate
string<date>

Start date for lead filtering (YYYY-MM-DD)

endDate
string<date>

End date for lead filtering (YYYY-MM-DD)

page
string

Page number for pagination

size
string

Number of items per page

Response

Leads retrieved successfully

collectedCustomers
object[]
I