How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Chatwoot

Chatwoot Contacts API

Contact management APIs

Documentation Provider Profile APIs.io OpenAPI GitHub

Chatwoot Contacts API is one of 40 APIs that Chatwoot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 8 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.chatwoot.com/, https://app.chatwoot.com.

11 operations 8 paths 24 schemas 1 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.chatwoot.com
Authentication
API Key, API Key, API Key
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

Chatwoot Contacts API declares 3 security schemes for authenticating requests. An API key is passed in the header as api_access_token (userApiKey). An API key is passed in the header as api_access_token (agentBotApiKey). An API key is passed in the header as api_access_token (platformAppApiKey).

  • userApiKey — This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can…
  • agentBotApiKey — This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.
  • platformAppApiKey — This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Paths & Operations 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 11

Contact management APIs

GET
/api/v1/accounts/{account_id}/contacts
List Contacts
contactList 4 params → 200400
POST
/api/v1/accounts/{account_id}/contacts
Create Contact
contactCreate 2 params body → 200400
GET
/api/v1/accounts/{account_id}/contacts/{id}
Show Contact
contactDetails 2 params → 200404403
PUT
/api/v1/accounts/{account_id}/contacts/{id}
Update Contact
contactUpdate 2 params body → 204404403
DELETE
/api/v1/accounts/{account_id}/contacts/{id}
Delete Contact
contactDelete 2 params → 200401404
GET
/api/v1/accounts/{account_id}/contacts/{id}/conversations
Contact Conversations
contactConversations 3 params → 200404403
GET
/api/v1/accounts/{account_id}/contacts/search
Search Contacts
contactSearch 5 params → 200401
POST
/api/v1/accounts/{account_id}/contacts/filter
Contact Filter
contactFilter 3 params body → 200400
POST
/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes
Create contact inbox
contactInboxCreation 2 params body → 200401422
GET
/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes
Get Contactable Inboxes
contactableInboxesGet 2 params → 200401422
POST
/api/v1/accounts/{account_id}/actions/contact_merge
Merge Contacts
contactMerge 1 param body → 200400401404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are conversation (27 properties), message (22 properties), user (20 properties), contact_list_item (13 properties). Each schema is shown below with its type and property counts.

contact_base
contact_inboxes
object
2 properties
inbox_contact
object
6 properties
contact_inbox
object
2 properties
bad_request_error
object
2 properties
contact
object
1 property
generic_id
object
1 property
message
object
22 properties
contact_list_item
object
13 properties
contact_update_payload
object
9 properties
contact_show_response
object
1 property
extended_contact
conversation
object
27 properties
contact_conversations_response
object
1 property
contact_create_payload
object
10 properties 1 required
contact_meta
object
2 properties
user
object
20 properties
request_error
object
3 properties
contacts_list_response
object
2 properties
contactable_inboxes_response
object
1 property
Contact
object
7 properties
ContactCreate
object
5 properties
FilterPayload
object
1 property
ContactList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwoot-contacts-api-openapi.yml Raw ↑

Other APIs Chatwoot publishes across the network.

Chatwoot Client API
AE Profile APIs.io
Chatwoot Platform API
AE Profile APIs.io
Chatwoot Account AgentBots API
AE Profile APIs.io
Chatwoot Account API
AE Profile APIs.io
Chatwoot Account Users API
AE Profile APIs.io
Chatwoot Accounts API
AE Profile APIs.io
Chatwoot AgentBots API
AE Profile APIs.io
Chatwoot Agents API
AE Profile APIs.io
Chatwoot Audit Logs API
AE Profile APIs.io
Chatwoot Automation Rule API
AE Profile APIs.io
Chatwoot Canned Responses API
AE Profile APIs.io
Chatwoot Contact Labels API
AE Profile APIs.io
#Contacts
← Back to C APIs
API Details
ID
chatwoot:chatwoot-contacts-api
Base URL
https://app.chatwoot.com
Docs
https://developers.chatwoot.com/api-reference/introduction
Provider
Chatwoot
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=chatwoot-contacts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/chatwoot-contacts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Chatwoot Contacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put 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.