Onboarding API

Endpoints

GET /api/onboarding/phases

Returns all phases with their items, filtered by the user’s job role.

Permission: view:onboarding

Response:

{
  "data": {
    "phases": [
      {
        "id": "phase-1",
        "name": "Foundation",
        "description": "Week 1 (Days 1-3): Core setup and orientation",
        "items": [
          {
            "id": "p1-hr-1",
            "category": "HR & Admin",
            "title": "Complete employment paperwork",
            "detail": "Tax file declaration, super choice form...",
            "owner": "HR"
          }
        ]
      }
    ]
  }
}

GET /api/onboarding/progress

Returns onboarding progress for the current user (or scoped users based on access level).

Permission: view:onboarding

PUT /api/onboarding/progress/:itemId

Toggle an onboarding item’s completion status.

Permission: update:onboarding

Body:

{
  "completed": true,
  "notes": "Optional note"
}