API reference
The OpenAPI 3.1 contract, rendered: the document every Kommio server serves at /api/openapi, without the operator-only endpoints.
Last updated
445 operations across conversations, messages, contacts, inboxes and channels, teams, roles and access, saved views, automations, macros, chatbot flows, SLA policies, reports (the Reports API for BI tools: tables and time series as JSON, CSV or Excel, saved report views and scheduled reports), satisfaction surveys, the knowledge base, data connectors, integrations, imports (Chatwoot and CSV) and exports, webhooks, bots, apps, AI assist, API keys, single sign-on and the widget. Set the server URL to your workspace and add a bearer key to try requests.
Raw document: openapi.json, synced from the repository's committed contract (CI fails when the server and the contract disagree). The operator-only /platform and /ops endpoints, used by the people running a Kommio server, are left out here; your own server's /api/openapi lists them.
Every claim on these pages is covered by a test in the repository, and the API reference is generated from the same contract every server serves at /api/openapi. Corrections to [email protected].