> ## Documentation Index
> Fetch the complete documentation index at: https://developers.chatwoot.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Chatwoot Platform APIs

# Chatwoot Platform APIs

The Chatwoot Platform APIs allow you to integrate a conversation management interface into your existing software stack. Installation admins can use these APIs to manage users, accounts, and roles. Additionally, these APIs can be used to sync authentication information from external systems into Chatwoot.

> **Note:** These APIs are available only on `self-hosted` Chatwoot installations.

## Creating a Platform App

To create a platform app, follow these steps:

1. Go to the super admin portal and navigate to `super_admin/platform_apps`.

   <img src="https://mintcdn.com/chatwoot-447c5a93/0ZKii1AePO4f9gzo/contributing-guide/images/platform-app/super_admin.png?fit=max&auto=format&n=0ZKii1AePO4f9gzo&q=85&s=660c2a608911520248d80ebee3b9ffc6" alt="Super Admin Portal" width="2920" height="2316" data-path="contributing-guide/images/platform-app/super_admin.png" />

2. Click on the "New platform app" button.

   <img src="https://mintcdn.com/chatwoot-447c5a93/0ZKii1AePO4f9gzo/contributing-guide/images/platform-app/platform-home.png?fit=max&auto=format&n=0ZKii1AePO4f9gzo&q=85&s=e385b7249e139980d1b15ad5dbe01e85" alt="Platform Apps Home" width="2924" height="2330" data-path="contributing-guide/images/platform-app/platform-home.png" />

3. Fill in the platform app name and click the "Create" button.

   <img src="https://mintcdn.com/chatwoot-447c5a93/0ZKii1AePO4f9gzo/contributing-guide/images/platform-app/platform-create.png?fit=max&auto=format&n=0ZKii1AePO4f9gzo&q=85&s=b5fdebe799b984f864c2a5b771de5d18" alt="Create Platform App" width="2918" height="2324" data-path="contributing-guide/images/platform-app/platform-create.png" />

4. After creating the platform app, open it to view and copy the access token.

   <img src="https://mintcdn.com/chatwoot-447c5a93/0ZKii1AePO4f9gzo/contributing-guide/images/platform-app/platform-access-token.png?fit=max&auto=format&n=0ZKii1AePO4f9gzo&q=85&s=159082152782602a02c7c13a69f2d49f" alt="Platform App Access Token" width="2922" height="2328" data-path="contributing-guide/images/platform-app/platform-access-token.png" />

## Using the Access Token

The `access_token` is required to authenticate all API requests. Please use the Postman collection to test these APIs.

### Testing the APIs

To test the APIs:

1. Copy the access token from the platform app.
2. Use it in the `Authorization` header of your API requests.

Here's an example of creating a user using the API:

<img src="https://mintcdn.com/chatwoot-447c5a93/0ZKii1AePO4f9gzo/contributing-guide/images/platform-app/create-user.png?fit=max&auto=format&n=0ZKii1AePO4f9gzo&q=85&s=713572e72629dfd935d303dce408014c" alt="Create User API" width="2794" height="2144" data-path="contributing-guide/images/platform-app/create-user.png" />

Similarly, you can create `Account` and `Role` entities using the APIs.

## Reference

For more detailed information and to test the APIs, refer to our [Postman Collection](https://www.postman.com/chatwoot/workspace/chatwoot-apis/collection/162770-e5451b69-9f97-489b-b352-4ca7d8d82aff).