---
title: "List User Roles"
method: GET
path: "/roles"
tags: ["User Management", "User Roles"]
---

# List User Roles

`GET /roles`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/roles`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/roles/get.ts> (a function with typed inputs; its response is checked against the schema)

This API retrieves a list of all available user roles in the system.

It includes:

- Role names (e.g., Admin, Manager, Viewer)
- Permissions associated with each role
- Role IDs for assignment and management

## Headers

- `Authorization` string

## Response `200`

Successfully retrieved user roles

- object
  - `data` object
    - `fetchAccountRoles` UserRoleV2[]
      - `id` string, required: Base64 encoded unique identifier for the role
      - `name` string, required: Name of the role
      - `createdAt` string, date-time, required: Role creation timestamp
      - `updatedAt` string, date-time, required: Role last update timestamp

## Other responses

- `401`: Unauthorized - Authentication required
- `403`: Forbidden - Insufficient permissions

---

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