GET
/api/v1/staffList
hr:viewSCREEN GUIDE · 11 OCT 2026
Staff directory & lifecycle
Use staff directory & lifecycle in the school workspace. Maintain staff profiles, inspect connected responsibilities and record departure or reinstatement.
OVERVIEW
What you can do
01
Offboard
02
Reinstate
03
Download Template
04
Export to Excel
05
List
06
List Former
07
Add a staff member
08
What still depends on this person
09
Mark a staff member as having left
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
hr:viewhr:createhr:manageUse 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
Find or create the staff profile
A school account with the permissions shown below.
- 02
Review employment details and linked responsibilities
Reinstate is part of the documented workflow.
- 03
Inspect clearance before offboarding
Download Template is part of the documented workflow.
- 04
Use reinstatement when returning a former staff member
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 |
|---|---|---|
employeeCode | string | Required by declaration |
firstName | string | Required by declaration |
lastName | string | Optional |
gender | string | Optional |
dateOfBirth | string | Optional |
email | string | Optional |
phone | string | Optional |
branchId | string | Optional |
departmentId | string | Optional |
designationId | string | Optional |
reportsToId | string | Optional |
joiningDate | string | Optional |
contractType | string | Optional |
qualifications | unknown | Optional |
exitStatus | 'RESIGNED' | 'TERMINATED' | 'RETIRED' | Optional |
exitDate | string | Optional |
reason | string | Optional |
force | boolean | Optional |
CURRENT BEHAVIOUR
Rules & current limits
- Offboarding is separate from deleting historical school activity. Permission and dependency checks govern each action.
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 directory & lifecycle
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.
6 source-declared operations
GET
/api/v1/staff/formerList Former
hr:viewPOST
/api/v1/staffAdd a staff member
hr:createDeclared request fields: employeeCode (required), firstName (required), lastName (optional), gender (optional), dateOfBirth (optional), email (optional), phone (optional), branchId (optional), departmentId (optional), designationId (optional), reportsToId (optional), joiningDate (optional), contractType (optional), qualifications (optional).
GET
/api/v1/staff/:id/clearanceWhat still depends on this person
hr:viewPOST
/api/v1/staff/:id/offboardMark a staff member as having left
hr:manageDeclared request fields: exitStatus (optional), exitDate (optional), reason (optional), force (optional).
POST
/api/v1/staff/:id/reinstateReinstate
hr:manageOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.