---
title: "Get Roles"
method: GET
path: "/"
---

# Get Roles

`GET /`

## Request

- Base URL: `https://api.umbrellacost.io/api/v2/user-management/roles`
- URL: `https://api.umbrellacost.io/api/v2/user-management/roles/`
- Auth: none declared. Required headers: `Authorization`, `apikey`

Get the list of roles in the organization

## Headers

- `Authorization` string, required
- `apikey` string, required

## Response `200`

Successful operation

- object
  - `roles` object[]
    - `id` string: Use this id in future requests to update this specific role
    - `displayName` string
    - `description` string
    - `roleReferenceId` string
    - `createdAt` string
    - `createdBy` string
    - `updatedAt` string
    - `updatedBy` string
    - `usersCount` integer
    - `editable` boolean
  - `paginationToken` string
  - `total` integer

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/umbrellacost/apis/user-management-roles-api.md) - [All operations](https://skmtc.dev/umbrellacost/apis/user-management-roles-api/llms.txt) - [OpenAPI document](https://skmtc.dev/umbrellacost/apis/user-management-roles-api/revisions/d4427b9dd512?raw)