API Documentation
Automate your chat workflows, sync leads to your CRM, and build custom integrations using the SaaS Chat Platform REST API.
Authentication
All API requests require a Bearer API key in the Authorization header. Generate API keys from your dashboard under Settings → API Keys.
API keys are prefixed with sk_ and can be scoped to specific permissions (read, write, leads:read, conversations:read, messages:write).
Base URL
All endpoints are prefixed with /v1/public/. Responses are JSON. Errors follow { message, statusCode } shape.
Endpoints
Conversations
/conversationsList conversations. Filter by status (open/resolved) or channel. Paginated.
/conversations/:idGet a single conversation by ID with full metadata.
/conversations/:id/messagesGet paginated message history for a conversation.
/conversations/:id/messagesSend a message to a conversation as bot or agent.
Leads
/leadsList leads. Filter by status (new/contacted/qualified/closed). Paginated.
/leads/:idUpdate lead status.
Analytics
/analytics/summary30-day analytics summary: SLA metrics (avg reply time, resolution time) + daily volume.
Webhooks
/webhook-eventsList all available webhook event types.
/webhooksRegister a new webhook endpoint to receive event notifications.
Meta
/API info: version, rate limits, code examples, docs URL.
Code Examples
Quick-start examples in your language of choice.
// List conversations
const res = await fetch('https://api.saaschat.io/v1/public/conversations', {
headers: { 'Authorization': 'Bearer sk_your_api_key' },
});
const { items, meta } = await res.json();
// Send a message
await fetch('https://api.saaschat.io/v1/public/conversations/conv_id/messages', {
method: 'POST',
headers: {
'Authorization': 'Bearer sk_your_api_key',
'Content-Type': 'application/json',
},
body: JSON.stringify({ content: 'Hello!', senderType: 'bot' }),
});Rate Limits
Rate limits apply per API key. Exceeding limits returns 429 Too Many Requests.
| Plan | Requests / min | Requests / day |
|---|---|---|
| Starter | 30 | 1,000 |
| Pro | 120 | 10,000 |
| Elite | 600 | 100,000 |
Changelog
2026-05-01
Initial public API release — conversations, leads, analytics, webhooks