JavaScript Embed Features
API Reference
Advanced Integration
Get a specific contact
Copy
curl --request GET \
--url https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>'Copy
{
"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
}
}Contacts
Get a specific contact
Retrieves a single contact by ID
GET
/
chatbots
/
{chatbotId}
/
contacts
/
{contactId}
Get a specific contact
Copy
curl --request GET \
--url https://www.chatbase.co/api/v1/chatbots/{chatbotId}/contacts/{contactId} \
--header 'Authorization: Bearer <token>'Copy
{
"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
}
}Authorizations
API key in Bearer token format
Path Parameters
ID of the chatbot
External ID of the contact
Response
Contact retrieved successfully
Example:
"Success"
Show child attributes
Show child attributes
Internal contact ID
Example:
"contact_internal_123"
External contact identifier
Example:
"user_123"
Contact's name
Example:
"John Doe"
Contact's email address
Example:
Contact's phone number
Example:
"+1234567890"
Array of Stripe accounts associated with this contact
Show child attributes
Show child attributes
Label identifier for the Stripe account
Example:
"main"
Stripe customer ID
Example:
"cus_123abc456"
Email address associated with the Stripe account
Example:
Example:
[
{
"label": "main",
"stripe_id": "cus_123abc456",
"stripe_email": "[email protected]"
}
]
Custom attributes for the contact
Example:
{
"department": "Sales",
"subscription_tier": "Premium"
}
Contact creation timestamp (Unix timestamp)
Example:
1704067200
Last update timestamp (Unix timestamp)
Example:
1704153600
⌘I