---
title: "List custom user roles"
method: GET
path: "/api/{cloudId}/v1/roles"
tags: ["Custom user roles"]
---

# List custom user roles

`GET /api/{cloudId}/v1/roles`

Returns the list of the custom user roles.  
 - The user should have admin role and custom user role right.

## Query parameters

- `offset` integer
- `size` integer

## Response `200`

Returned if the request is successful.

- PaginatedResponseCustomUserRoleSummaryResponse
  - `values` CustomUserRoleSummaryResponse[]
    - `id` string — The id of the custom user role.
    - `name` string — The name of the custom user role.
  - `_expands` string[]
  - `links` CustomRolesLinks
    - `next` string
    - `first` string
    - `last` string

## Other responses

- `400` — Returned if an field is not properly set.
- `403` — Returned if the request user does not have permission to get the list of custom user roles.
- `404` — Returned if the role with the identifier cannot be found.
- `422` — Returned if the requested identifier doesn't belong to custom user role.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)