Skip to main content
GET
/
api
/
v1
/
system
/
roles
List roles
curl --request GET \
  --url https://api.example.com/api/v1/system/roles/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "<string>",
    "id": 123,
    "permissions": [
      123
    ]
  }
]

Authorizations

Authorization
string
header
required

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

Headers

X-Schema-Name
string

School (tenant) identifier. Must match your account unless you have platform-wide access.

Response

200 - application/json
name
string
required
Maximum string length: 150
id
integer
permissions
integer[]