Get a role
Get a single role for a given role_id. The role is returned with the scopes assigned to it.
accounts.roles--all:roAuthorizations
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.
Path Parameters
Unique role ID.
Response
OK: Returns the role.
Role groups account scopes into one permission entity.
Unique role definition ID.
The default product for the account.
LiveChat, Accounts, ChatBot, HelpDesk, OpenWidget The role name; can be one of the predefined roles or a custom role name.
owner, viceowner, administrator, normal, member The role type: primary is an obligatory accounts role, secondary is a basic product role, custom is a custom-defined role.
If true: the role is common across all organizations. If false: the role is specific to an organization.
Scopes assigned to the role, separated by a comma (,).