Skip to main content
GET
List 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:1000

The number of items per page

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

Enable or disable pagination

isUserType
boolean
isUserType[]
boolean[]
isLocalCenter
boolean
isLocalCenter[]
boolean[]
isNational
boolean
isNational[]
boolean[]
order[position]
enum<string>
default:asc
Available options:
asc,
desc
order[id]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[unitType.id]
enum<string>
default:asc
Available options:
asc,
desc
exists[isLocalCenter]
boolean

Response

200 - application/json

Role collection

id
integer
read-only
name
string
namePlural
string | null
unitType
object | null
position
integer | null
isUserType
boolean | null
options
(string | null)[] | null
isLocalCenter
boolean | null
isLocalCenterParent
boolean | null
isNational
boolean | null
permissions
(string | null)[] | null
chartName
string | null
isNotEligibleForFee
boolean | null
isParent
boolean | null
isVolunteer
boolean | null
slug
string | null