List Roles - SnackBase

GET

api

roles

List Roles

curl --request GET \
  --url https://api.example.com/api/v1/roles

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "total": 123
}

Successful Response

Response schema for listing roles.

Attributes: items: List of roles. total: Total number of roles.

items

RoleListItem · object[]

required

Show child attributes

total

integer

required

List Roles

curl --request GET \
  --url https://api.example.com/api/v1/roles

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "total": 123
}