Skip to main content
GET
Retrieve a role

Authorizations

Authorization
string
header
required

A management key (created from the organization dashboard or with POST /v3/manage/auth-keys), sent as Authorization: Bearer <management_key>. Inference API keys (sk-eden...) are not accepted on these endpoints.

Path Parameters

role_id
integer
required

The role's id.

Response

200 - application/json

A role. System roles (is_system: true) are shared by every organization and cannot be changed; the others are the organization's own. guardrail_id is the guardrail that applies to the role's members, or null.

id
integer
required
read-only
name
string
required
Maximum string length: 100
guardrail_id
integer
required
read-only
description
string
is_system
boolean
permissions
string[]
Maximum string length: 100