---
title: "Get Role by ID"
method: GET
path: "/roles/{id}"
tags: ["Roles"]
---

# Get Role by ID

`GET /roles/{id}`

Get a role by ID

## Path parameters

- `id` string, objectid, required — The ID of the item to get

## Response `200`

OK

- ControllersResponseGithubModelsRole
  - `data` ModelsRole — The data to update
    - `_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

## Other responses

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

## Changes

> 3 revisions in range; 1 could not be searched.

- **2025-03-03** `14e4eafea538` — 1 breaking, 3 warning, 2 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
  - …2 more
- **2025-03-02** `526e5bdf6dee` — 1 breaking, 12 warning, 8 info
  - added the pattern `^[0-9a-fA-F]{24}$` to the `path` request parameter `id`
  - removed the optional property `data/_id` from the response with the `200` status
  - removed the optional property `data/created_at` from the response with the `200` status
  - removed the optional property `data/created_by` from the response with the `200` status
  - …17 more

[Change history](https://skmtc.dev/crawlab-team/apis/crawlab-api/changes/roles/:id/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/c7a4715c1f13/schema)