List roles
GET {{baseUrl}}/api/v2/roles
Returns all roles, including their names and their unique identifiers.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page[size] | number | Size for a given page. The maximum allowed value is 100. | |
page[number] | number | Specific page number to return. | |
sort | string | 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. | |||
filter | string | Filter all roles by the given string. | |
filter[id] | string | Filter all roles by the given list of role IDs. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"roles","attributes":{"created_at":"1968-09-18T01:31:40.786Z","modified_at":"1945-02-17T17:16:27.246Z","name":"aliqua labore anim","user_count":6399991},"id":"dolor nulla","relationships":{"permissions":{"data":[{"id":"cillum quis","type":"permissions"},{"id":"commodo est et mollit adipisicing","type":"permissions"}]}}},{"type":"roles","attributes":{"created_at":"2023-08-22T23:11:33.485Z","modified_at":"2017-08-19T12:50:37.782Z","name":"aliqua enim amet nulla","user_count":-83939923},"id":"consectetur non magna","relationships":{"permissions":{"data":[{"id":"amet nisi in","type":"permissions"},{"id":"in consequat deserunt nisi","type":"permissions"}]}}}],"meta":{"page":{"total_count":78520069,"total_filtered_count":88420530}}}