v66

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

Get permission

Retrieve details about a specific permission including its name, description, and metadata.

Required Permissions

Your root key must have the following permission:

  • rbac.*.read_permission
post/v2/permissions.getPermission

Request body

permissionstring required

The unique identifier of the permission to retrieve. Must be a valid permission ID that begins with 'perm_' and exists within your workspace.

Example request

{
  "permission": "perm_1234567890abcdef"
}

Response

Permission retrieved successfully

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "perm_1234567890abcdef",
    "name": "users.read",
    "slug": "users-read",
    "description": "Allows reading user profile information and account details"
  }
}