---
title: "List user roles"
method: GET
path: "/v1/users/roles"
tags: ["Users > Roles"]
---

# List user roles

`GET /v1/users/roles`

Retrieve existing user roles.

## Query parameters

- `take` number, nullable
- `skip` number, nullable

## Response `200`

- PaginatedUserRole
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` UserRole[], required — List of UserRole.
    - `id` string, required — Role ID.
    - `name` string, required — Role name.
    - `description` string, nullable, required — Role description.
    - `is_default` boolean, required — Whether this is the default role assigned to new users.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)