---
title: "List custom instance roles"
method: GET
path: "/admin/roles"
tags: ["Admin"]
---

# List custom instance roles

`GET /admin/roles`

## Request

- Base URL: `https://cloud.kaneo.app/api`
- URL: `https://cloud.kaneo.app/api/admin/roles`
- Auth: HTTP bearer

List the custom instance roles with their permissions and how many users have each. The built-in `admin` (every permission) and `user` (none) roles are not listed. Requires the `users:read` instance permission; API keys are rejected.

## Response `200`

Custom instance roles by name

- InstanceRoleList
  - `roles` InstanceRole[], required
    - `id` string, required
    - `name` string, required
    - `permissions` string[], required
    - `userCount` integer, required: Users who currently have this role.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `401`: Missing or invalid credentials
- `403`: The caller lacks the instance permission or used an API key
- `429`: The API key exceeded its rate limit or usage quota. Wait the number of seconds in Retry-After before retrying. The X-RateLimit headers are sent only when the rate limit was hit.

## Changes

- **2026-10-27** `8f3ec578c70a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usekaneo/apis/kaneo-api/changes/admin/roles/get.md)

---

[API](https://skmtc.dev/usekaneo/apis/kaneo-api.md) - [All operations](https://skmtc.dev/usekaneo/apis/kaneo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usekaneo/apis/kaneo-api/revisions/741a49dfb347?raw)