Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Onboarding

Show onboarding steps for an employment

Returns onboarding steps and substeps in a hierarchical, ordered structure.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View employments (employment:read)Manage employments (employment:write)
get/v1/employments/{employment_id}/onboarding-steps

Path parameters

employment_idstring uuid required

Identifier of the employment being terminated.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Employment ID

Response

Success

Example response

{
  "data": {
    "steps": [
      {
        "completed_at": "2025-02-18T14:30:00Z",
        "id": "step_1",
        "label": "Adding and inviting employee",
        "started_at": "2025-02-18T10:00:00Z",
        "status": "completed",
        "sub_steps": [
          {
            "completed_at": "2025-02-18T12:00:00Z",
            "id": "company_adds_employment_details",
            "label": "Company adds employment details",
            "optional": false,
            "started_at": "2025-02-18T10:00:00Z",
            "status": "completed",
            "type": "company_adds_employment_details"
          },
          {
            "completed_at": "2025-02-18T14:30:00Z",
            "id": "company_invites_employee",
            "label": "Company invites employee",
            "optional": false,
            "started_at": "2025-02-18T12:30:00Z",
            "status": "completed",
            "tag": "Draft",
            "type": "company_invites_employee"
          }
        ],
        "type": "getting_started"
      }
    ]
  }
}