cURL
curl --request GET \ --url https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts \ --header 'Authorization: Bearer <token>'
{ "message": "Success", "data": [ { "id": "contact_internal_123", "external_id": "user_123", "name": "John Doe", "email": "[email protected]", "phonenumber": "+1234567890", "stripe_accounts": [ { "label": "main", "stripe_id": "cus_123abc456", "stripe_email": "[email protected]" } ], "custom_attributes": { "department": "Sales", "subscription_tier": "Premium" }, "created_at": 1704067200, "updated_at": 1704153600 } ], "total": 250, "pages": { "page": 1, "per_page": 100, "total_pages": 3 } }
Retrieves paginated list of contacts for a specific chatbot
API key in Bearer token format
ID of the chatbot
Number of contacts per page (10-1000)
10 <= x <= 1000
Page number (starts from 1)
x >= 1
Contacts retrieved successfully
"Success"
Show child attributes
Internal contact ID
"contact_internal_123"
External contact identifier
"user_123"
Contact's name
"John Doe"
Contact's email address
"[email protected]"
Contact's phone number
"+1234567890"
Array of Stripe accounts associated with this contact
Label identifier for the Stripe account
"main"
Stripe customer ID
"cus_123abc456"
Email address associated with the Stripe account
[ { "label": "main", "stripe_id": "cus_123abc456", "stripe_email": "[email protected]" }]
Custom attributes for the contact
{ "department": "Sales", "subscription_tier": "Premium"}
Contact creation timestamp (Unix timestamp)
1704067200
Last update timestamp (Unix timestamp)
1704153600
Total number of contacts
250
1
100
3