Get all roles

Returns default Makaira.* roles and, when Role Manager is booked, custom {customer}.* roles. Requires role:read or usermanagement.read.

Request

GET /role

Query Parameters

ParameterTypeDefaultDescription
qstring""Case-insensitive name filter.
_startinteger0Pagination offset.
_endinteger10End index (exclusive). Page size is _end - _start.
withPermissionsbooleanfalseWhen true, each role includes a permissions array.

Headers

HeaderValue
AuthorizationBearer <token> (or HMAC headers, see Authentication)

Response

JSON array of roles. Total count is in the X-Total-Count header.

Example Response

[
  {
    "id": "rol_abc123",
    "name": "Makaira.ADMIN",
    "description": "Administrator"
  }
]
Query Params
string
integer
integer
boolean
Response
200

Successful response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here!