This is not our API. This repository is an independent, third-party profile of a company's publicly available API surface, maintained by API Evangelist. API Evangelist does not operate, host, resell, or support this company's APIs, and is not affiliated with or endorsed by the company unless stated on the profile.
Where the information came from. Everything here is assembled from material a member of the public can reach with a browser and no credentials — the company's own website, developer portal and documentation, the specifications it publishes for public use (OpenAPI, AsyncAPI, JSON Schema,
apis.json,llms.txtand similar), its public repositories, and its public status, pricing and changelog pages. Nothing here is obtained by breaching a system, defeating an access control, or using credentials of any kind.The rating is an independent assessment. The Kin Score and Agent Readiness rating are independently calculated scores of a company's public API artifacts, produced by API Evangelist against a published rubric. They are not certifications, endorsements, security assessments, or audits, and they score published artifacts — not the quality, safety, or security of the software.
Corrections, re-scores, and removal are free. No partnership, contract, or purchase is required, and you do not need to justify the request.
- Something wrong? Open an issue on this repository, or email info@apievangelist.com.
- Published something new? Ask for a re-score and we will re-run the rating.
- Want the listing taken down? Say so and we will honor it. The profile is reduced to your company name, a factual description, and a link to your own site, and the company is recorded as unrated — never scored zero for having asked.
Response times. Acknowledgement within one business day; removal or restriction within two business days; corrections and re-scores within five business days.
On a security or compliance team? Email info@apievangelist.com with security in the subject line and you will get a person, not a form. We will tell you exactly which public URLs this profile was built from so your team can see the same surface we did, and we will take the listing down on request while you work through it.
Full detail: Where this data comes from
Chatwoot is an open-source customer engagement and support suite that unifies email, live-chat, social, and messaging channels into a single shared inbox. Agents, teams, contacts, conversations, and messages are all managed through a REST API surface split across an Application API, a Client API for end-user widgets, and a Platform API for super-admin installation control. Chatwoot is available as self-hostable open-source software and as Chatwoot Cloud.
APIs.json: https://raw.githubusercontent.com/api-evangelist/chatwoot-com/refs/heads/main/apis.yml
- Customer Support
- Customer Engagement
- Shared Inbox
- Live Chat
- Open Source
- Omnichannel
- Help Desk
- Created: 2026-07-01
- Modified: 2026-07-01
Application and Platform API requests authenticate with an api_access_token HTTP header (an agent/user token for the Application API, a Platform App token for the Platform API). Client API requests are scoped by an inbox identifier and a contact identifier / pubsub token rather than a static header key. Chatwoot Cloud is served from https://app.chatwoot.com; for self-hosted installations substitute your own host.
Manage agents within an account - list, add, update the role and availability of, and remove agents who staff the shared inbox.
- Human URL: https://developers.chatwoot.com/api-reference/agents
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Agents
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create and manage teams and their agent membership so conversations can be routed to the right group of agents.
- Human URL: https://developers.chatwoot.com/api-reference/teams
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Teams
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
List, create, update, and delete inboxes across channels (website live-chat, email, and social/messaging), and manage the agents assigned to each inbox.
- Human URL: https://developers.chatwoot.com/api-reference/inboxes
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Inboxes
- Channels
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Manage contacts - create, list, search, filter, update, and delete the people who reach out, plus list a contact's conversations, contactable inboxes, and labels.
- Human URL: https://developers.chatwoot.com/api-reference/contacts
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Contacts
- CRM
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create and manage conversations - list with filters, toggle status, assign to agents or teams, update priority, and manage conversation labels and custom attributes.
- Human URL: https://developers.chatwoot.com/api-reference/conversations
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Conversations
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create, list, and delete messages within a conversation, including outgoing agent replies, private notes, and attachments.
- Human URL: https://developers.chatwoot.com/api-reference/messages
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Messages
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
List the account's labels and read or set the labels applied to individual conversations and contacts for organization and reporting.
- Human URL: https://developers.chatwoot.com/api-reference/labels
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Labels
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Define and manage custom attribute definitions for conversations and contacts so installation-specific data can be captured and filtered on.
- Human URL: https://developers.chatwoot.com/api-reference/custom-attributes
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Custom Attributes
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Manage canned responses (saved replies) - list, create, update, and delete the short-code reply templates agents use to answer faster.
- Human URL: https://developers.chatwoot.com/api-reference/canned-responses
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Canned Responses
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Create and manage automation rules that fire on events (conversation created, updated, message created) to auto-assign, label, and act on conversations from conditions.
- Human URL: https://developers.chatwoot.com/api-reference/automation-rule
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Automation
- Rules
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Retrieve account-level and agent/team/inbox/label-level metrics - conversation counts, incoming/outgoing volume, resolution and response times, and conversation summary reports.
- Human URL: https://developers.chatwoot.com/api-reference/reports
- Base URL:
https://app.chatwoot.com/api/v1/accounts/{account_id}
- Reports
- Analytics
- Application API
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
End-user (widget-facing) API to create and update the contact tied to an inbox identifier, returning a pubsub token used to authenticate that contact's subsequent client requests.
- Human URL: https://developers.chatwoot.com/api-reference/client-apis/contacts
- Base URL:
https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}
- Client API
- Contacts
- Widget
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
End-user API for a contact to create and list their conversations and to toggle status, toggle typing, and update last-seen from within a custom chat interface.
- Human URL: https://developers.chatwoot.com/api-reference/client-apis/conversations
- Base URL:
https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}
- Client API
- Conversations
- Widget
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
End-user API for a contact to create, list, and update messages in their conversation, powering a fully custom chat widget on top of Chatwoot.
- Human URL: https://developers.chatwoot.com/api-reference/client-apis/messages
- Base URL:
https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}
- Client API
- Messages
- Widget
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Super-admin API to create, read, update, and delete users across an installation and to obtain a single-sign-on login URL for a user.
- Human URL: https://developers.chatwoot.com/api-reference/platform-apis/users
- Base URL:
https://app.chatwoot.com/platform/api/v1
- Platform API
- Users
- Administration
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Super-admin API to provision and manage accounts on an installation and to manage the association of users to accounts via account users.
- Human URL: https://developers.chatwoot.com/api-reference/platform-apis/accounts
- Base URL:
https://app.chatwoot.com/platform/api/v1
- Platform API
- Accounts
- Administration
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Super-admin API to create, read, update, and delete agent bots that can be attached to inboxes to power conversational automation.
- Human URL: https://developers.chatwoot.com/api-reference/platform-apis/agentbots
- Base URL:
https://app.chatwoot.com/platform/api/v1
- Platform API
- Agent Bots
- Automation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
FN: Kin Lane Email: kin@apievangelist.com