---
title: "Get a list of user roles"
method: GET
path: "/api/v2/organizations/{orgSlug}/user-roles"
tags: ["User Roles"]
---

# Get a list of user roles

`GET /api/v2/organizations/{orgSlug}/user-roles`

## Request

- Base URL: `https://app.officernd.com`
- URL: `https://app.officernd.com/api/v2/organizations/{orgSlug}/user-roles`
- Auth: OAuth 2
  - Authorization code: `https://identity.officernd.com/auth/authorize`
  - Client credentials
  - Token URL: `https://identity.officernd.com/auth/token` scopes: `flex.user.userRoles.read`

Retrieve the user roles in the organization, optionally filtered by user or member. `role` is the stored role value: a system role name or, for custom roles, the custom role name. `locations` lists the locations a role is restricted to (empty means all locations). Some restricted users can still read data in all locations through a secondary viewer role, which this endpoint does not expose. 

 Required scopes: `flex.user.userRoles.read`

## Path parameters

- `orgSlug` string, required

## Query parameters

- `user` string
- `member` string
- `$select` string
- `$cursorNext` string
- `$cursorPrev` string
- `$limit` number

## Response `200`

- object
  - `rangeStart` number
  - `rangeEnd` number
  - `cursorNext` string
  - `cursorPrev` string
  - `results` UserRoleResultDto[]
    - `_id` string: The _id of the user role.
    - `user` string: The _id of the user the role is granted to.
    - `member` string, nullable: The _id of the member linked to the user, or null when the user has no linked member.
    - `role` string: The role as stored for the user. System roles are "owner", "admin", "viewer", "reception", "center_manager" (or legacy "Center Manager") and "Member" for portal members. Custom role names are returned as stored. "none" or "None" means no access.
    - `locations` string[]: The ids of the locations the role is restricted to (empty = all locations).

---

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