v7

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-013764062.2 MB

Users

Get a single role

Enterprise feature

Get a single role by role id

get/api/admin/roles/{roleId}

Path parameters

roleIdstring required

Response

roleWithPermissionsSchema

idnumber required

The role id

typestring required

A role can either be a global root role, or a project role or a custom project role or a custom global root-custom role

namestring required

The name of the role

descriptionstring

A more detailed description of the role and what use it's intended for

Example response

{
  "id": 9,
  "type": "root",
  "name": "Editor",
  "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
  "permissions": [
    {
      "id": 3,
      "name": "UPDATE_FEATURE",
      "displayName": "Update feature flags",
      "type": "project",
      "environment": "development"
    }
  ]
}