GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
These docs are for v2024-03-01. Click to read the latest docs for v2026-02-01.

Get the company's onboarding status

get
https://api.gusto-demo.com/v1/companies//onboarding_status

Get company's onboarding status. The data returned helps inform the required onboarding steps and respective completion status.

scope: company_onboarding_status:read

Path Params
string
required

The UUID of the company

Query Params
string

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

Headers
string
enum
Defaults to 2024-03-01

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

Allowed:
Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago