---
title: "Get Roles"
method: GET
path: "/business/v2/roles"
tags: ["Permissions"]
---

# Get Roles

`GET /business/v2/roles`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/roles`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `role_read`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/roles/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to retrieve all `User` `Roles`.

## Response `200`

The result is an array of `UserRoles`.

- UserRoles
  - `total` integer: It represents the total number of available items in the list.
  - `results` Role[]
    - `id` string: The ID of the `Role`.
    - `name` string: The name of the `Role`.
    - `description` string: The description of the `Role`.
    - `category` string: The category of the `Role`.
    - `scopes` string[]: The scopes of the `Role`.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)