---
title: "Get roles list"
method: GET
path: "/roles"
tags: ["Permissions"]
---

# Get roles list

`GET /roles`

Get list of all roles

## Query parameters

- `page` integer
- `size` integer
- `all` boolean

## Response `200`

List of roles

- object
  - `code` integer
  - `message` string
  - `data` object
    - `list` object[]
      - `_id` string — MongoDB ObjectId represented as a hexadecimal string
      - `name` string — Name of the role
      - `description` string — Description of the role
      - `permissions` object[] — Permissions granted to this role
        - `resource` string — Resource name
        - `actions` string[]
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string — MongoDB ObjectId represented as a hexadecimal string
      - `updated_by` string — MongoDB ObjectId represented as a hexadecimal string
    - `total` integer

## Changes

- **2025-03-03** `14e4eafea538` — 1 breaking, 3 warning, 4 info
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `code` from the response with the `200` status
  - removed the optional property `data` from the response with the `200` status
  - removed the optional property `message` from the response with the `200` status
  - …4 more
- **2025-03-02** `526e5bdf6dee` — 1 breaking, 7 warning, 7 info
  - the `data` response's property type/format changed from `array`/`` to `object`/`` for status `200`
  - deleted the `query` request parameter `filter`
  - deleted the `query` request parameter `page`
  - deleted the `query` request parameter `size`
  - …11 more

[Change history](https://skmtc.dev/crawlab-team/apis/crawlab-api/changes/roles/get.md)

---

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