Skip to main content
GET
List user roles

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:20

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

unit
string
unit[]
string[]
user
string
user[]
string[]
role
string
role[]
string[]
role.unitType
string
role.unitType[]
string[]
role.isNational
boolean
role.isNational[]
boolean[]
role.isLocalCenter
boolean
role.isLocalCenter[]
boolean[]
user.status
string
user.status[]
string[]
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[user.lastName]
enum<string>
default:asc
Available options:
asc,
desc
order[role.position]
enum<string>
default:asc
Available options:
asc,
desc
exists[dateEnded]
boolean
exists[role.isLocalCenter]
boolean
exists[role.isNational]
boolean

Response

200 - application/json

UserRole collection

id
integer
read-only
role
object | null
user
object
unit
object | null
dateCreated
string<date-time>
isAdmin
boolean | null