GET
/api/v1/ai-features/staff-workloadList Staff Workload
timetable:view, attendance:updateSCREEN GUIDE · 11 OCT 2026
Staff workload
Use the staff workload workspace to review its saved runs, context and available actions.
OVERVIEW
What you can do
01
Input and context selection
02
Saved result review
03
Available history and comparisons
04
Human review
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
Required permission keys
timetable:viewattendance:updateUse the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.
STEP BY STEP
How the workflow works
- 01
Review the input context and provider/data state
A school account with the permissions shown below.
- 02
Run or open the relevant saved result
Saved result review is part of the documented workflow.
- 03
Inspect the available evidence and comparison
Available history and comparisons is part of the documented workflow.
- 04
Review the outcome before acting on it
Review the result in the connected record or workspace before moving on.
Request fields to understand
Source-declared fields used by related operations; each operation has its own validation and scope.
| Field | Declared type | Input |
|---|---|---|
overloadThreshold | number | Optional |
mediumThreshold | number | Optional |
underutilizedRatio | number | Optional |
label | string | Optional |
absentStaffId | string | Required by declaration |
date | string | Optional |
apply | boolean | Optional |
CURRENT BEHAVIOUR
Rules & current limits
- The current provider can return sample output. Configured credentials do not prove a verified provider, live GPS feed or reliable prediction.
Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.
LEARN BY DOING
Launch guided demo →Try staff workload
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
4 source-declared operations
POST
/api/v1/ai-features/staff-workloadRun Staff Workload
timetable:view, attendance:updateDeclared request fields: overloadThreshold (optional), mediumThreshold (optional), underutilizedRatio (optional), label (optional).
POST
/api/v1/ai-features/staff-workload/substitutionsSuggest Substitutions
timetable:view, attendance:updateDeclared request fields: absentStaffId (required), date (optional), apply (optional).
GET
/api/v1/ai-features/staff-workload/:idGet Staff Workload
timetable:view, attendance:updateOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.