Get organization role details
Retrieves complete information for a specific organization role including metadata, inheritance details, and optionally permissions. Use this endpoint to audit role configuration and understand the role's place in the organization's role hierarchy. You can include permission details to see what capabilities the role provides. This operation is useful for role management, user assignment decisions, or understanding organization access controls.
Path parameters
Unique identifier of the organization
Unique name of the role
Query parameters
Include additional data in the response. Valid values: 'permissions' (direct permissions only), 'permissions:all' (includes inherited permissions)
Response
Successfully retrieved organization role details. Returns the role object including metadata and inheritance details. Permissions are included only when requested via the include parameter.
Example response
{
"role": {
"default_creator": true,
"default_member": true,
"dependent_roles_count": 3,
"description": "Can create, edit, and publish content but cannot delete or manage users",
"display_name": "Content Editor",
"extends": "admin_role",
"id": "role_1234abcd5678efgh",
"is_org_role": true,
"name": "content_editor",
"permissions": [
{
"description": "Read Content",
"name": "read:content",
"role_name": "admin_role"
},
{
"description": "Write Content",
"name": "write:content",
"role_name": "editor_role"
}
]
}
}