Skip to main content
GET
/
chatbots
/
{chatbotId}
/
contacts
Get contacts for a chatbot
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": "john@example.com",
      "phonenumber": "+1234567890",
      "stripe_accounts": [
        {
          "label": "main",
          "stripe_id": "cus_123abc456",
          "stripe_email": "john@example.com"
        }
      ],
      "custom_attributes": {
        "department": "Sales",
        "subscription_tier": "Premium"
      },
      "created_at": 1704067200,
      "updated_at": 1704153600
    }
  ],
  "total": 250,
  "pages": {
    "page": 1,
    "per_page": 100,
    "total_pages": 3
  }
}

Documentation Index

Fetch the complete documentation index at: https://chatbase.co/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key in Bearer token format

Path Parameters

​
chatbotId
string
required

ID of the chatbot

Query Parameters

​
per_page
integer

Number of contacts per page (10-1000)

Required range: 10 <= x <= 1000
​
page
integer

Page number (starts from 1)

Required range: x >= 1

Response

Contacts retrieved successfully

​
message
string
Example:

"Success"

​
data
object[]
​
total
integer

Total number of contacts

Example:

250

​
pages
object