---
title: "Get company onboarding status"
method: GET
path: "/v1/companies/{company_uuid}/onboarding_status"
tags: ["Companies"]
---

# Get company onboarding status

`GET /v1/companies/{company_uuid}/onboarding_status`

Retrieves a company's onboarding status, including whether onboarding is complete and the list of
required onboarding steps with their respective completion state.

scope: `company_onboarding_status:read`

## Path parameters

- `company_uuid` string, required

## Query parameters

- `additional_steps` string

## Headers

- `X-Gusto-API-Version` '2026-06-15'

## Response `200`

Success

- CompanyOnboardingStatus — The representation of a company's onboarding status
  - `uuid` string, required — the UUID of the company
  - `onboarding_completed` boolean — a boolean flag for the company's onboarding status
  - `onboarding_steps` object[] — a list of company onboarding steps
    - `title` string — The display name of the onboarding step
    - `id` 'add_addresses' | 'federal_tax_setup' | 'select_industry' | 'add_bank_info' | 'add_employees' | 'state_setup' | 'payroll_schedule' | 'sign_all_forms' | 'verify_bank_info' | 'external_payroll' — The string identifier for each onboarding step
    - `required` boolean — The boolean flag indicating whether the step is required or optional
    - `completed` boolean — The boolean flag indicating whether the step is completed or not.
    - `completed_at` string, nullable — The ISO 8601 timestamp indicating when the onboarding step was completed.
    - `skippable` boolean — The boolean flag indicating whether the step can be skipped or not.
    - `requirements` string[] — A list of onboarding steps that are required to be completed in order to proceed with the current onboarding step.

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/gusto/apis/gusto-api.md) · [All operations](https://skmtc.net/gusto/apis/gusto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gusto/gusto-api/revisions/826dfa57fb3b/schema)