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 Teams API

Application API - manage teams and membership.

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

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

This API exposes 5 operations across 2 paths, and defines 2 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.

5 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 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 Teams 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 5

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

Teams 5

Application API - manage teams and membership.

GET
/api/v1/accounts/{account_id}/teams
List teams in an account.
listTeams 1 param → 200
POST
/api/v1/accounts/{account_id}/teams
Create a team.
createTeam 1 param body → 200
GET
/api/v1/accounts/{account_id}/teams/{team_id}
Get a team by id.
getTeam 2 params → 200
PATCH
/api/v1/accounts/{account_id}/teams/{team_id}
Update a team.
updateTeam 2 params body → 200
DELETE
/api/v1/accounts/{account_id}/teams/{team_id}
Delete a team.
deleteTeam 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Team (5 properties), TeamCreate (3 properties). Each schema is shown below with its type and property counts.

Team
object
5 properties
TeamCreate
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chatwoot-com-teams-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