Skip to main content
GET
List the organization roles (system + custom) for member management selectors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
any[]

No extend options available for this route.

orderBy
object[]
whereName
string

Case-insensitive partial match on the role name.

Maximum string length: 200
Example:

"lobby"

whereIds
string<uuid>[]

Filter by one or more role ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereOrigin
string[]

Filter by where the role comes from: system (seeded with the organization), library (adopted from the catalogue), custom (defined by the organization).

Example:
whereSystemKey
string[]

Filter by the built-in role key (admin, operator, reader).

Example:
whereHasHolders

When true, only the roles at least one member holds; when false, only the ones nobody holds.

Example:

true

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required