Skip to main content
GET
Get role
Requires roles:read. A role outside the current organization returns 404. is_inherited: true identifies a copy managed through the main billing organization. Its name may match a local role with different permissions. Use role_id to identify the intended role.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

role_id
string<uuid>
required

Role ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
description
string | null
required
permissions
enum<string>[]
required
Available options:
*,
sessions:read,
sessions:write,
team-sessions:read,
team-sessions:write,
assigned-sessions:read,
assigned-sessions:write,
hybrid-inbox:read,
phone-outbound-all-numbers:write,
sessions-personal-views:write,
sessions-shared-views:read,
sessions-shared-views:write,
sessions-create:write,
sessions-sub-sessions:write,
merge-sessions:write,
sessions-delete-own-messages:write,
contacts:read,
contacts:write,
companies:read,
companies:write,
sequences:read,
sequences:write,
ai-training:read,
ai-training:write,
reports:read,
reports:write,
help-center:read,
help-center:write,
help-center-content:read,
help-center-content:write,
workflows:read,
workflows:write,
workflows:execute,
actions:read,
actions:write,
mini-apps:read,
mini-apps:write,
companion:read,
companion:write,
redaction:read,
redaction:write,
voc:read,
voc:write,
audit-logs:read,
settings:read,
settings:write,
settings-general:read,
settings-general:write,
settings-billing:read,
settings-billing:write,
settings-api-keys:read,
settings-api-keys:write,
settings-autopilot:read,
settings-autopilot:write,
settings-structured-fields:read,
settings-structured-fields:write,
settings-webhooks:read,
settings-webhooks:write,
settings-secrets:read,
settings-secrets:write,
settings-handoff:read,
settings-handoff:write,
settings-translations:read,
settings-translations:write,
settings-sso:read,
settings-sso:write,
settings-security:read,
settings-security:write,
settings-integrations:read,
settings-integrations:write,
settings-members:read,
settings-members:write,
settings-agent-availability:read,
settings-agent-availability:write,
settings-tags:read,
settings-tags:write,
settings-sla:read,
settings-sla:write,
settings-csat:read,
settings-csat:write,
settings-reports:read,
settings-reports:write,
settings-office-hours:read,
settings-office-hours:write,
settings-channels:read,
settings-channels:write,
settings-channels-voice:read,
settings-channels-voice:write,
settings-email-fleet:read,
settings-email-fleet:write,
settings-helpdesk:read,
settings-helpdesk:write,
settings-custom-statuses:read,
settings-custom-statuses:write,
settings-availability-statuses:read,
settings-availability-statuses:write,
settings-personal-profile:read,
settings-personal-profile:write,
settings-groups:read,
settings-groups:write,
settings-roles:read,
settings-roles:write,
settings-scim-role-mappings:read,
settings-scim-role-mappings:write,
settings-macros:read,
settings-macros:write,
settings-skills:read,
settings-skills:write
is_inherited
boolean

Inherited roles are read-only in this organization. A local and inherited role may share a name; use their IDs to distinguish them.