API Documentation
Integrate BloomChats with your backend, CRM, or internal tools. RESTful API with JSON responses, API key authentication, and webhook support.
Base URL
https://api.bloomchats.com
Auth Header
X-API-Key: YOUR_KEY
Format
JSON request & response
TLS
HTTPS required (TLS 1.2+)
Authentication
All API requests require an API key sent via the X-API-Key header. Generate your API key from Settings > API in your BloomChats dashboard.
curl -X GET "https://api.bloomchats.com/api/contacts" \ -H "X-API-Key: dmtb_live_abc123xyz789"
Keep your API key secure
Never expose your API key in client-side code or public repositories. Use environment variables and server-side requests only.
Error Handling
The API returns standard HTTP status codes. Error responses include a JSON body with details.
// 401 Unauthorized
{
"error": "invalid_api_key",
"message": "The API key provided is invalid or expired.",
"status": 401
}
// 429 Too Many Requests
{
"error": "rate_limit_exceeded",
"message": "Rate limit exceeded. Retry after 60 seconds.",
"status": 429,
"retry_after": 60
}Rate Limits
SDKs & Libraries
Python
Availablepip install bloomchatsNode.js
Availablenpm install @bloomchats/sdkPHP
Coming Sooncomposer require bloomchats/sdkReady to Build?
Create your free account to get an API key and start integrating BloomChats into your stack.