Help Center / API access

API access & tokens

The workspace API v1 provides read-only access to chatbots, conversations, leads, and analytics for integrations and reporting.

Enable API access

Your plan must include the api_access feature. Generate tokens from Settings → API with workspace.settings permission.

Create a token

Name the token for easy identification (e.g. "CRM sync"). The plain token is shown once — copy it immediately. Tokens are stored as hashes server-side.

Authentication

Send the token as a Bearer header on all v1 requests:

Authorization: Bearer YOUR_TOKEN

Available endpoints

• GET /api/v1/chatbots — List chatbots
• GET /api/v1/chatbots/{id} — Chatbot detail
• GET /api/v1/conversations — List conversations
• GET /api/v1/conversations/{id} — Conversation with messages
• GET /api/v1/leads — List leads
• GET /api/v1/leads/{id} — Lead detail
• GET /api/v1/analytics/summary — Analytics summary (requires analytics feature)

Rate limits

API requests are throttled per workspace token. The v1 API is read-only — create and update operations are not exposed.

Revoke tokens

Delete a token from Settings → API to immediately invalidate it. Rotate tokens periodically for security.