Chatwoot Contacts API
Application API - manage contacts.
Chatwoot Contacts API is one of 17 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 an API reference.
This API exposes 8 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://app.chatwoot.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Chatwoot Contacts API declares
2 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 (platformAppApiKey).
By default, every request must be authenticated.
userApiKey— Application and Client access token passed in the apiaccesstoken HTTP header. For the Application API this is an agent/user access token; Client API requests a…platformAppApiKey— Platform App access token passed in the apiaccesstoken HTTP header. Created by a super-admin from the Chatwoot installation's Platform Apps area and required f…
Paths & Operations 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Application API - manage contacts.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Contact (7 properties), ContactCreate (5 properties), ContactList (2 properties), FilterPayload (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Chatwoot 12
Other APIs Chatwoot publishes across the network.