List roles
GET {{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>
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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"type":"roles","attributes":{"created_at":"\u003cdateTime\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","user_count":"\u003clong\u003e"},"id":"\u003cstring\u003e","relationships":{"permissions":{"data":[{"id":"\u003cstring\u003e","type":"permissions"},{"id":"\u003cstring\u003e","type":"permissions"}]}}},{"type":"roles","attributes":{"created_at":"\u003cdateTime\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","user_count":"\u003clong\u003e"},"id":"\u003cstring\u003e","relationships":{"permissions":{"data":[{"id":"\u003cstring\u003e","type":"permissions"},{"id":"\u003cstring\u003e","type":"permissions"}]}}}],"meta":{"page":{"total_count":"\u003clong\u003e","total_filtered_count":"\u003clong\u003e"}}}