Scopes
Scopes can be used to limit the actions that can be performed by an API token. The following scopes are available:
| Scope | Description |
|---|---|
| announcements-read | List announcements sent to you or scheduled by you |
| announcements-write | Create and manage your announcements |
| api-tokens-read | List metadata for your API tokens |
| categories-read | List categories attached to your chats |
| categories-write | Manage your category aliases |
| chats-read | List general details of your chats |
| chats-write | Manage your chats |
| messages-read | Read message history in your chats |
| messages-write | Send messages and typing indicators in your chats |
| profile-read | View your user profile information |
| profile-write | Update your user profile information |
| profile-contact | Include email, phone and external_id in your user profile |
| tasks-read | List tasks you created, are assigned to, or that are in your chats |
| tasks-write | Create and manage tasks visible to you |
| users-read | List users visible to you |
| users-write | Manage your user settings |
| webhooks-read | List your webhook endpoints |
| webhooks-write | Manage your webhook endpoints |
| org-announcements-read | List all announcements in the organization |
| org-api-tokens-read | List API token metadata for all users in the organization |
| org-categories-read | List all categories in the organization |
| org-categories-write | Manage all categories in the organization |
| org-chats-read | List all chats in the organization |
| org-chats-write | Manage all chats in the organization |
| org-messages-read | Read message history for all chats in the organization |
| org-messages-write | Send messages and typing indicators to any chat in the organization |
| org-users-read | List all users in the organization |
| org-users-write | Manage all users in the organization |
Scopes prefixed with org- can only be used by users with the admin role. Requesting these scopes for other users will not grant them access to administrative functions.
The webhooks-read and webhooks-write scopes also require the admin role, and integrations must be enabled for the organization.
User Privacy
To protect privacy, email, phone and external_id are not typically included in user objects. If you want to grant access to your contact data when calling GET /users/me, request the profile-contact scope.
The org-chats-read and org-users-read scopes are intended for system-level provisioning integration and gives access to email, phone, and external_id on all user objects.