Sign in

v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB
permissions

Get role

Retrieve details about a specific role including its assigned permissions.

Required Permissions

Your root key must have the following permission:

  • rbac.*.read_role
post/v2/permissions.getRole

Request body

rolestring required

Unique identifier of the role to permanently delete from your workspace. Must either be a valid role ID that begins with 'role_' or the given role name and exists within your workspace.

Use this endpoint to verify role details, check its current permissions, or retrieve metadata. Returns complete role information including all assigned permissions for comprehensive access review.

Example request

{
  "role": "role_1234567890abcdef"
}

Response

Role retrieved successfully

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "role_1234567890abcdef",
    "name": "support.readonly",
    "description": "Provides read-only access for customer support representatives to view user accounts and support tickets",
    "permissions": [
      {
        "id": "perm_1234567890abcdef",
        "name": "users.read",
        "slug": "users-read",
        "description": "Allows reading user profile information and account details"
      }
    ]
  }
}