v1
latestOpenAPI 3.1.02026-07-243113441.2 MBCompanies
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
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