Skip to main content
GET
List roles

Authorizations

Authorization
string
header
required

Plerion organization API key (plerion_oak_…), created by an organization admin in the Plerion app. GET operations work with a key of either access level; POST, PUT and DELETE require the readWrite access level.

Query Parameters

scope
enum<string>

Return only roles of this scope.

Available options:
organization,
tenant
tenantId
string<uuid>

Return only custom roles bound to this tenant.

cursor
string

The meta.cursor value from the previous page, passed back unchanged. Cursors are opaque and URL-safe.

perPage
string

Items per page, 1 to 1000.

Pattern: ^[1-9][0-9]{0,2}$|^1000$

Response

Roles, built-in first.

data
object[]
meta
object