---
title: "Users holding a role"
method: GET
path: "/v1/Roles/definitions/{id}/users"
tags: ["Roles"]
---

# Users holding a role

`GET /v1/Roles/definitions/{id}/users`

## Request

- Base URL: `https://api.invendor.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.invendor.com/v1/Roles/definitions/{id}/users`
- Auth: OAuth 2
  - Authorization code: `https://identity.scanbro.com/connect/authorize`
  - Token URL: `https://identity.scanbro.com/connect/token` scopes: `io.common`
- TypeScript: <https://skmtc.dev/invendor/apis/io-commonapi/docs/v1/Roles/definitions/:id/users/get.ts> (a function with typed inputs; its response is checked against the schema)

The users holding the role, from the companies the caller has access to (their own and the related
ones), or from every company when the caller belongs to the tenant primary account. Members of hidden
groups are left out, as in the users list. The account query parameter is ignored: unlike the users
list, this one is not narrowed to a single company.
            
Filter matches username, firstName, lastName, email, profileName and accountName.
Sortable columns: id, username, firstName, lastName, email, profileId, profileName, accountId, accountName
(default lastName).

## Path parameters

- `id` string, required

## Query parameters

- `Filter` string
- `Page` integer
- `PageSize` integer
- `SortColumn` string
- `SortOrder` string
- `Account` unknown

## Response `200`

Success

- RoleHolderResponsePagedResult
  - `pageSize` integer
  - `page` integer
  - `totalCount` integer
  - `filteredCount` integer
  - `data` RoleHolderResponse[], nullable
    - `id` integer
    - `username` string, nullable
    - `firstName` string, nullable
    - `lastName` string, nullable
    - `email` string, nullable
    - `profileId` integer
    - `profileName` string, nullable
    - `accountId` integer, nullable
    - `accountName` string, nullable

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-10-12** `1239b9eaa9bb`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/invendor/apis/io-commonapi/changes/v1/Roles/definitions/:id/users/get.md)

---

[API](https://skmtc.dev/invendor/apis/io-commonapi.md) - [All operations](https://skmtc.dev/invendor/apis/io-commonapi/llms.txt) - [OpenAPI document](https://skmtc.dev/invendor/apis/io-commonapi/revisions/6a4a4fd7114d?raw)