Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chatwoot Platform Accounts API

Platform API - super-admin account management.

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

Tagged areas include Platform Accounts. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 7 operations across 3 paths. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://app.chatwoot.com.

7 operations 3 paths 0 schemas 2 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://app.chatwoot.com/api/v1/accounts/{account_id}
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Chatwoot Platform Accounts 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 7

Across 3 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Platform Accounts 7

Platform API - super-admin account management.

POST
/platform/api/v1/accounts
Create an account on the installation.
createPlatformAccount body → 200
GET
/platform/api/v1/accounts/{account_id}
Get an account by id.
getPlatformAccount 1 param → 200
PATCH
/platform/api/v1/accounts/{account_id}
Update an account.
updatePlatformAccount 1 param → 200
DELETE
/platform/api/v1/accounts/{account_id}
Delete an account.
deletePlatformAccount 1 param → 200
GET
/platform/api/v1/accounts/{account_id}/account_users
List the users associated with an account.
listPlatformAccountUsers 1 param → 200
POST
/platform/api/v1/accounts/{account_id}/account_users
Associate a user with an account with a role.
createPlatformAccountUser 1 param body → 200
DELETE
/platform/api/v1/accounts/{account_id}/account_users
Remove a user's association with an account.
deletePlatformAccountUser 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwoot-com-platform-accounts-api-openapi.yml Raw ↑

Other APIs Chatwoot publishes across the network.

Chatwoot Agents API
Chatwoot Automation Rules API
Chatwoot Canned Responses API
Chatwoot Client Contacts API
Chatwoot Client Conversations API
Chatwoot Client Messages API
Chatwoot Contacts API
Chatwoot Conversations API
Chatwoot Custom Attributes API
Chatwoot Inboxes API
Chatwoot Labels API
Chatwoot Messages API