Chatwoot

Chatwoot Platform Accounts API

Platform API - super-admin account management.

Documentation GitHub OpenAPI

Business capability

Tenant Provisioning & Lifecycle BC-4230.10

Operations 7

POST /platform/api/v1/accounts Create an account on the installation #

GET /platform/api/v1/accounts/{account_id} Get an account by id #

PATCH /platform/api/v1/accounts/{account_id} Update an account #

DELETE /platform/api/v1/accounts/{account_id} Delete an account #

GET /platform/api/v1/accounts/{account_id}/account_users List the users associated with an account #

POST /platform/api/v1/accounts/{account_id}/account_users Associate a user with an account with a role #

DELETE /platform/api/v1/accounts/{account_id}/account_users Remove a user's association with an account #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/chatwoot/refs/heads/main/openapi/chatwoot-platform-accounts-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/chatwoot-platform-accounts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Chatwoot Platform Accounts API
  description: Chatwoot is an open-source customer engagement suite with a shared inbox across email, live-chat, social, and messaging channels.
  termsOfService: https://www.chatwoot.com/terms-of-service/
  contact:
    name: Chatwoot Developers
    url: https://developers.chatwoot.com
  license:
    name: MIT (core) with additional Chatwoot license terms for some features
    url: https://github.com/chatwoot/chatwoot/blob/develop/LICENSE
  version: '1.0'
servers:
- url: https://app.chatwoot.com
  description: Chatwoot Cloud. For self-hosted installations, substitute your own host.
security:
- userApiKey: []
tags:
- name: Platform Accounts
  description: Platform API - super-admin account management.
paths:
  /platform/api/v1/accounts:
    post:
      operationId: createPlatformAccount
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: Create an account on the installation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
      responses:
        '200':
          description: The created account.
  /platform/api/v1/accounts/{account_id}:
    parameters:
    - $ref: '#/components/parameters/AccountId'
    get:
      operationId: getPlatformAccount
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: Get an account by id
      responses:
        '200':
          description: The account.
    patch:
      operationId: updatePlatformAccount
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: Update an account
      responses:
        '200':
          description: The updated account.
    delete:
      operationId: deletePlatformAccount
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: Delete an account
      responses:
        '200':
          description: Deleted.
  /platform/api/v1/accounts/{account_id}/account_users:
    parameters:
    - $ref: '#/components/parameters/AccountId'
    get:
      operationId: listPlatformAccountUsers
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: List the users associated with an account
      responses:
        '200':
          description: Array of account users.
    post:
      operationId: createPlatformAccountUser
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: Associate a user with an account with a role
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: integer
                role:
                  type: string
                  enum:
                  - administrator
                  - agent
      responses:
        '200':
          description: The created account user.
    delete:
      operationId: deletePlatformAccountUser
      tags:
      - Platform Accounts
      security:
      - platformAppApiKey: []
      summary: Remove a user's association with an account
      responses:
        '200':
          description: Removed.
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: The numeric id of the account.
      schema:
        type: integer
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: Application and Client access token passed in the `api_access_token` HTTP header. For the Application API this is an agent/user access token; Client API requests are additionally scoped by inbox and contact identifiers.
    platformAppApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: Platform App access token passed in the `api_access_token` HTTP header. Created by a super-admin from the Chatwoot installation's Platform Apps area and required for all /platform/api/v1 endpoints.