Companies

Get company 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

get/v1/companies/{company_uuid}/onboarding_status

Request

Base URL
https://api.gusto-demo.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/gusto/apis/gusto-api/docs/v1/companies/:company_uuid/onboarding_status/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

company_uuidstring required

The UUID of the company

Query parameters

additional_stepsstring

Comma-delimited string of additional onboarding steps to include. Currently only supports the value "external_payroll".

Headers

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

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Success

uuidstring required

the UUID of the company

onboarding_completedboolean

a boolean flag for the company's onboarding status

Changes

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