List Available Permissions
Returns every permission that can be given to a staff member on the Custom role, in the order the SalaryBox app’s role grid shows them. These are the only names Set Staff Permissions (PUT /staff/{salarybox_id}/permissions) accepts. The list is the same for every company. This endpoint takes no parameters and is not paginated.
What is returned
permission: the name to send to Set Staff Permissions.category: the section of the role grid, for example “Attendance Data”.sub_category: the row inside that section, for example “Staff Attendance Records”.requires: permissions that must be granted together with this one. An:editpermission needs its:viewpermission; the list is empty when nothing is required.
When to use this endpoint
- Read it instead of hard-coding the names, so your integration keeps working if SalaryBox adds a permission. The same list is also on the Staff Permissions page.
Authentication
AuthorizationApi-Key
Format: “Api-Key {api-key}”
Response
All permissions that can be given to a Custom-role staff member.
message
status
data
