Skip to main content
GET
Get Role

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

role_id
string
required

The unique identifier of the role (a system role ID or a custom role ID)

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Response

Successful response with the role

role
object
required

A role available in your organization — a built-in system role or a custom role.