v1

latestOpenAPI 3.0.32026-07-13201451.3 KB
Contacts

Get contacts for a chatbot

Retrieves paginated list of contacts for a specific chatbot

get/chatbots/{chatbotId}/contacts

Path parameters

chatbotIdstring required

ID of the chatbot

Query parameters

per_pageinteger

Number of contacts per page (10-1000)

pageinteger

Page number (starts from 1)

Response

Contacts retrieved successfully

messagestring
totalinteger

Total number of contacts

Example response

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