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

# Get Role List

`GET /roles`

Get a list of roles

## Query parameters

- `filter` string — Filter query
- `page` integer — Page number
- `size` integer — Page size
- `sort` string — Sort options

## Response `200`

OK

- ControllersListResponseGithubModelsRole
  - `data` ModelsRole[]
    - `_id` string, objectid — ID
    - `created_at` string, date-time — Created timestamp
    - `created_by` string, objectid — Created by
    - `description` string — Description
    - `name` string — Name
    - `root_admin` boolean
    - `routes` string[] — Routes
    - `updated_at` string, date-time — Updated timestamp
    - `updated_by` string, objectid — Updated by
    - `users` integer
  - `error` string
  - `message` string
  - `status` string
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

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