Show onboarding steps for an employment

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

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

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

get/v1/employments/{employment_id}/onboarding-steps

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/employments/{employment_id}/onboarding-steps
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, employment:read, employment:write, employments, all:write, all:read)

Path parameters

employment_idstring uuid required

A unique identifier in UUID v4 format.

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"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.