v1

latestOpenAPI 3.0.32026-07-13201451.3 KB
Leads

Get leads for a chatbot

Retrieves collected leads/customers for a specific chatbot

get/get-leads

Query parameters

chatbotIdstring required

ID of the chatbot

startDatestring date

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

endDatestring date

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

pagestring

Page number for pagination

sizestring

Number of items per page

Response

Leads retrieved successfully

Example response

{
  "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"
    }
  ]
}