---
title: "List roles"
method: GET
path: "/roles"
tags: ["Roles"]
---

# List roles

`GET /roles`

## Query parameters

- `keyword` string
- `page` integer
- `pageSize` integer
- `active` boolean
- `system` boolean

## Response `200`

OK

- ApiResponseRoleList
  - `success` boolean, required
  - `message` string, nullable
  - `timestamp` string, date-time, required
  - `data` object
    - `total` integer, required
    - `roles` Role[], required
      - `id` integer
      - `name` string
      - `displayName` string
      - `description` string, nullable
      - `isSystem` boolean
      - `isActive` boolean
      - `metadata` object, nullable
      - `accessedAt` string, date-time, nullable
      - `createdAt` string, date-time, nullable
      - `updatedAt` string, date-time, nullable

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

## Changes

- **2025-09-21** `29cedfcf6ce1` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/lobehub/apis/lobechat-openapi/changes/roles/get.md)

---

[API](https://skmtc.dev/lobehub/apis/lobechat-openapi.md) · [All operations](https://skmtc.dev/lobehub/apis/lobechat-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lobehub/lobechat-openapi/revisions/7be2ebcf191c/schema)