Skip to main content
GET
List roles
Required scopes: accounts.roles--all:ro

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Response

OK: Returns the list of roles.

role_id
string

Unique role definition ID.

product
enum<string>

The default product for the account.

Available options:
LiveChat,
Accounts,
ChatBot,
HelpDesk,
OpenWidget
role
enum<string>

The role name; can be one of the predefined roles or a custom role name.

Available options:
owner,
viceowner,
administrator,
normal,
member
type
string
read-only

The role type: primary is an obligatory accounts role, secondary is a basic product role, custom is a custom-defined role.

predefined
boolean
read-only

If true: the role is common across all organizations. If false: the role is specific to an organization.