Skip to content

Get customers

get/get-customers/{chatbotId}
Any key

Get the customers (leads) collected by a chatbot, newest first. Results are paginated.

Parameters

Sending 1 of 13 fields
Required
chatbotIdstring
The unique identifier allocated to the chatbot.
Try it · GET /get-customers/{chatbotId}
curl 'https://api.chat-data.com/api/v2/get-customers/6650f1c2a9e4b83d2c7a1f05' \  -H "Authorization: Bearer $CHAT_DATA_API_KEY"
Loading…

Responses

Successful response.

Content type: application/json

FieldDescription
statusstringOne of: success.
customersarray of objectThe customers, newest first.
customers[].leadIdstringThe unique identifier of the lead (UUID).
customers[].namestringThe name provided by the customer.
customers[].emailstringThe email address provided by the customer.
customers[].phonestringThe phone number provided by the customer.
customers[].psidstringThe page-scoped user ID of the customer, if the customer is from Messenger.
customers[].ig_usernamestringThe Instagram username of the customer, if the customer is from Instagram.
customers[].usernamestringSlack or Telegram username. A platform-specific identifier, distinct from ig_username (Instagram) and psid (Messenger).
customers[].infostringAdditional information stored on the lead.
customers[].sourcestringThe source the customer was acquired from. Only returned by get-customers. One of: widget, iframe, site, api, Whatsapp, WhatsappWebAPI, Messenger, Instagram, Telegram, Line, Slack, Discord, Workflow Studio, cron-trigger.
customers[].ipAddressstringThe IP address of the customer. Only returned by get-customers.
customers[].userCountrystringThe 2-letter ISO country code of the customer, based on an IP address lookup (Unknown when it could not be resolved). Only returned by get-customers.
customers[].createdAtnumberWhen the customer's information was submitted, in milliseconds since the Unix epoch.
totalnumberTotal number of matching customers, ignoring pagination.

Example

{  "status": "success",  "customers": [    {      "leadId": "8d0c2b6e-4f1a-4b7c-9e3d-2a5f6b7c8d9e",      "name": "Jane Doe",      "email": "[email protected]",      "source": "widget",      "phone": "+14155550123",      "ipAddress": "203.0.113.42",      "userCountry": "US",      "createdAt": 1791970200000    }  ],  "total": 10}

Last updated October 14, 2026