Skip to content

Read a role

Request

Returns one role: its name, its code, what it is allowed to do, and any limits on the records it may act on.

object.permissions is narrowed to what the account itself has available, so the same role read from two accounts can come back with different keys. The example below shows a handful of them rather than the whole set.

Security
default
Path
idintegerrequired

The ID of the role.

Headers
Rosterfy-Platformstring
curl -i -X GET \
  'https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/account/role/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Bodyapplication/json
objectobject
niceobject
relationsArray of any
permissionsobject
Response
{ "object": { "id": 5, "name": "Example Role", "code": "example-role", "permissions": { … }, "horizontal": null, "prefill": null, "is_system": 1, "is_lite_admin": 0, "is_simple_attribute_selection": 0, "is_restricted": 0, "is_inheritable": 0, "access_required_modules": null, "options": null, "created_at": "2026-06-09T05:33:39.000000Z", "updated_at": "2026-06-09T05:33:39.000000Z", "user_dashboard_id": null }, "nice": { "rrn": "rrn:local:20101:role:5" }, "relations": [], "permissions": { "read": true, "update": false, "delete": false, "update_message": "You cannot update a role you are assigned to.", "copy": true } }