Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Roles

List roles

Returns all roles, including their names and their unique identifiers.

get/api/v2/roles

Query parameters

page[size]integer
Example:10

Size for a given page. The maximum allowed value is 100.

page[number]integer

Specific page number to return.

sort'name' | '-name' | 'modified_at' | '-modified_at' | 'user_count' | '-user_count'

Sorting options for roles.

Sort roles depending on the given field. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example: sort=-name.

filterstring

Filter all roles by the given string.

filter[id]string

Filter all roles by the given list of role IDs.

Response

OK

Example response

{
  "data": [
    {
      "relationships": {
        "permissions": {
          "data": [
            {
              "type": "permissions"
            }
          ]
        }
      },
      "type": "roles"
    }
  ]
}