---
title: "List Roles"
method: GET
path: "/api/v1/onboarding/roles"
tags: ["Onboarding"]
---

# List Roles

`GET /api/v1/onboarding/roles`

## Request

- Base URL: `https://backend.caspr.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://backend.caspr.ai/api/v1/onboarding/roles`
- Auth: OAuth 2
  - Password
  - Token URL: `token`

Return all active user-role options for the onboarding UI.

## Response `200`

Successful Response

- UserRolesResponse
  - `success` boolean, required
  - `roles` UserRoleItem[]
    - `id` string, required
    - `name` string, required
    - `display_name` string, required
    - `description` string, nullable
    - `discount_tag` string, nullable
    - `display_order` integer, required

---

[API](https://skmtc.dev/caspr/apis/casper-api.md) - [All operations](https://skmtc.dev/caspr/apis/casper-api/llms.txt) - [OpenAPI document](https://skmtc.dev/caspr/apis/casper-api/revisions/f9765e3aa00c?raw)