List all Roles (Read-Only)

GET/api/roles

Roles are exposed read-only. A role holds the permission map of every staff member assigned to it, so granting or editing one through the API would be a privilege escalation path; create and edit roles in the RISE admin area instead. The serialised permissions column is omitted from this listing.

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area
curl -X GET "https://yoursite.com/api/roles" \
  -H "authtoken: YOUR_API_TOKEN"

Success-Response:

HTTP/1.1 200 OK
[
  { "id": "1", "title": "Project manager", "deleted": "0" },
  { "id": "2", "title": "Support agent", "deleted": "0" }
]

Error-Response:

HTTP/1.1 404 Not Found
{ "status": false, "messages": { "error": "No data were found" } }
MethodGET
Path/api/roles
GroupRoles
Sincev1.0.0
Defined inRestApi/Controllers/RolesController.php