Skip to main content
Documentation

Domain

Staff capabilities

11 capabilities, all acting on a staff. A reference to one from another domain is spelled staff_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.
CapabilityWhat it doesEffect
staff.listPOST /api/v1/staff/listList the staff on the roster, their skills and their workloadread-only
staff.getPOST /api/v1/staff/getGet one staff member's record, availability and live workread-only
staff.certificationsPOST /api/v1/staff/certificationsList which staff hold which certifications and when they lapseread-only
staff.rolesPOST /api/v1/staff/rolesList the roles this shop grants its staff and what each opensread-only
staff.pay_ratesPOST /api/v1/staff/pay_ratesRead what the shop's staff are paid, by rate and by typeread-only
staff.timesheetPOST /api/v1/staff/timesheetRead one week of the shop's staff clock, with hours per personread-only
staff.pay_periodsPOST /api/v1/staff/pay_periodsRead the shop's recent pay periods and what each staff run came toread-only
staff.on_the_clockPOST /api/v1/staff/on_the_clockList the staff clocked in right now and what they are working onread-only
staff.time_off_requestsPOST /api/v1/staff/time_off_requestsList the time-off requests waiting on a staff manager's answerread-only
staff.archivedPOST /api/v1/staff/archivedList the staff profiles archived out of the working rosterread-only
staff.role_matrixPOST /api/v1/staff/role_matrixList each staff role and exactly what it can open and changeread-only

← Every domain