Skip to main content
GET /api/v1/roles Requires roles.read permission. Returns both system-defined roles and any custom roles created for the current organization.

​
Response

​
roles
Role[]
required
Array of roles.

​
Errors

StatusWhen
401Missing or invalid Bearer token
403Caller lacks roles.read permission

​
Example

curl http://localhost:8080/api/v1/roles \
  -H "Authorization: Bearer <token>"

{
  "roles": [
    {
      "id": "r1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "key": "owner",
      "name": "Owner",
      "is_system": true,
      "permissions": ["org.read", "org.update", "org.delete", "members.read", "members.update", "members.remove", "members.invite", "roles.read", "roles.create", "roles.update", "roles.delete"]
    },
    {
      "id": "r2b2c3d4-e5f6-7890-abcd-ef1234567890",
      "key": "release_manager",
      "name": "Release Manager",
      "is_system": false,
      "permissions": ["flags.read", "flags.write", "rules.read", "rules.write"]
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us