# Staff directory & lifecycle

Maintain staff profiles, inspect connected responsibilities and record departure or reinstatement.

Category: People
Guide: https://avkul.in/docs/guides/module-staff/
Guided sample demo: https://avkul.in/docs/demo/module-staff/
Snapshot: 11 October 2026

## Features

- Directory
- Staff creation
- Profile 360
- Clearance
- Offboarding
- Reinstatement

## Access and setup

Intended access: Assigned account with the required permissions
- An assigned school account with the required permissions.
- The academic, student or staff setup used by this workflow.

Permission keys: hr:view, hr:create, hr:update, hr:manage

## Workflow

1. Find or create the staff profile.
2. Review employment details and linked responsibilities.
3. Inspect clearance before offboarding.
4. Use reinstatement when returning a former staff member.

## Fields and controls

- employeeCode (string, declared required)
- firstName (string, declared required)
- 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 limits

- Offboarding is separate from deleting historical school activity. Permission and dependency checks govern each action.

## Actual application access

- https://avkul.in/en/school/staff
- https://avkul.in/en/school/staff — select the actual record from this list.

## API reference

- GET /api/v1/staff — List; hr:view
- GET /api/v1/staff/former — List Former; hr:view
- POST /api/v1/staff — Add a staff member; hr:create
- PATCH /api/v1/staff/:id — Update; hr:update
- GET /api/v1/staff/:id/clearance — What still depends on this person; hr:view
- POST /api/v1/staff/:id/offboard — Mark a staff member as having left; hr:manage
- POST /api/v1/staff/:id/reinstate — Reinstate; hr:manage
- GET /api/v1/staff/:id — Get; hr:view
- GET /api/v1/staff/:id/profile-360 — Get Profile360; hr:view

## Demo access

No login is required for the guided sample demo. Its fictional records and actions stay in this browser tab; they do not modify ERP records or send messages/payments. An assigned account is required for the actual ERP links.

Source inventory checked on 11 October 2026. This source inventory is not a certification of every external provider or device flow.