Skip to main content
Chatwoot provides three types of APIs. This distinction is primarily based on the specific use cases for which these APIs are designed.
  1. Application APIs
  2. Client APIs
  3. Platform APIs
Ref: Chatwoot API Docs

​
Application APIs

Application APIs are designed to interact with a Chatwoot account from a user’s perspective. These APIs will help in building integrations for the support agents, bulk import/export of data into a Chatwoot account etc. To authenticate to this API, you will require a user access_token, which can be obtained from profile_settings after logging into your Chatwoot account. These APIs are available on both cloud and self-hosted Chatwoot Accounts. Ref: Postman Collection

​
Example Implementations

​
Client APIs

The client APIs allow users to build custom conversational interfaces over Chatwoot. Not happy with the native Chatwoot Website widget? Want to create a customer Chat support option right into your mobile app? Client APIs are here to help. Client APIs use a combination of inbox_identifier and contact_identifier for authentication. The inbox_identifier can be obtained from the Settings->Configuration of API inboxes in Chatwoot. The contact_identifier can be obtained from the server on successful contact Create API requests, which can be cached to perform subsequent requests on behalf of the contact. These APIs are available on both cloud and self-hosted Chatwoot Accounts. Ref: Postman Collection

​
Example Implementations

​
Platform APIs

The installation admin can use these APIs to manage users, accounts, and roles. These APIs could also be used to sync auth information from external systems into chatwoot. These APIs are particularly helpful if you plan to build a conversation management interface into your existing software stack.
Note: Platform APIs cannot access accounts or users created via the Chatwoot UI, or by other API keys. They can only access accounts, users, and other objects created by the specific platform API key used for authentication, or objects explicitly permitted to that API key.
To authenticate these APIs, you must have an access_token issued on behalf of a Platform app. You can create a Platform App from Super Admin Console. The access_token can also be obtained from the Access Tokens tab in Super Admin Console. These APIs are available on self-hosted Chatwoot installations. Ref: Postman Collection

​
FAQ

​
Why do I get a 401 ‘Non permissible resource’ error when using Platform API tokens?

Platform APIs cannot access accounts or users created via the Chatwoot UI, or by other API keys. They can only access accounts, users, and other objects created by the same API key, or objects explicitly permitted to that API key. If you need to grant a Platform App access to an object (such as an Account) that it did not create, you can manually add the permission using the following command in a Rails console (replace the numbers with the correct IDs): 
PlatformAppPermissible.create!(platform_app: PlatformApp.find(1), permissible: Account.find(1))

​
What should I do if the API documentation appears outdated?

If you encounter discrepancies between the API documentation and actual API behavior, we recommend inspecting the actual requests made by the Chatwoot UI through your browser’s developer console Network tab to see the exact request format and payload structure that works with the current API, then replicate the same request structure in your integration. You can contribute back by submitting a pull request with documentation corrections or by raising an issue in our GitHub repository to help keep our API documentation current for everyone.
⌘I