---
title: "Show onboarding steps for an employment"
method: GET
path: "/v1/employments/{employment_id}/onboarding-steps"
tags: ["Onboarding"]
---

# Show onboarding steps for an employment

`GET /v1/employments/{employment_id}/onboarding-steps`

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

## Scopes

| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View employments (`employment:read`) | Manage employments (`employment:write`) |

## Path parameters

- `employment_id` string, uuid, required — Identifier of the employment being terminated.

## Response `200`

Success

- EmploymentOnboardingStepsResponse
  - `data` object, required
    - `steps` Step[], required
      - `completed_at` string, nullable
      - `description` string, nullable
      - `id` string, required — Unique identifier for this step instance
      - `label` string, required — Human-readable step name
      - `started_at` string, nullable
      - `status` 'not_started' | 'in_progress' | 'completed' | 'failed', required — Step status
      - `sub_steps` SubStep[], required — Ordered list of substeps for this step
        - `completed_at` string, nullable
        - `id` string, required — Unique identifier for this substep
        - `label` string, required — Human-readable substep name
        - `optional` boolean, required — Whether this substep is optional
        - `started_at` string, nullable
        - `status` 'not_started' | 'in_progress' | 'completed' | 'failed', required — Substep status
        - `tag` string, nullable — Optional UI tag
        - `type` string, required — Substep type identifier
      - `type` string, required — Step type identifier

## Other responses

- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/revisions/7e6a0c61ac82/schema)