Get the employee's onboarding status

Description

Retrieves an employee's onboarding status. The data returned helps inform the required onboarding steps and respective completion status.

onboarding_status	Description
admin_onboarding_incomplete	Admin needs to complete the full employee-onboarding.
onboarding_completed	Employee has been fully onboarded and verified.

onboarding_status	Description
admin_onboarding_incomplete	Admin needs to enter basic information about the employee.
self_onboarding_pending_invite	Admin has the intention to invite the employee to self-onboard (e.g., marking a checkbox), but the system has not yet sent the invitation.
self_onboarding_invited	Employee has been sent an invitation to self-onboard.
self_onboarding_invited_started	Employee has started the self-onboarding process.
self_onboarding_invited_overdue	Employee's start date has passed, and employee has still not completed self-onboarding.
self_onboarding_completed_by_employee	Employee has completed entering in their information. The status should be updated via API to "self_onboarding_awaiting_admin_review" from here, once the Admin has started reviewing.
self_onboarding_awaiting_admin_review	Admin has started to verify the employee's information.
onboarding_completed	Employee has been fully onboarded and verified.

onboarding_steps	Requirement(s) to be completed
personal_details	Add employee's first name, last name, email, date of birth, social security number
compensation_details	Associate employee to a job & compensation.
add_work_address	Add employee work address.
add_home_address	Add employee home address.
federal_tax_setup	Set up federal tax withholdings.
state_tax_setup	Set up state tax withholdings.
direct_deposit_setup	(optional) Set up employee's direct deposit.
employee_form_signing	Employee forms (e.g., W4, direct deposit authorization) are generated & signed.
file_new_hire_report	File a new hire report for this employee.
admin_review	Admin reviews & confirms employee details (only required for Employee self-onboarding)

scope: employees:read

employee_idstring required

The UUID of the employee

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.

successful

uuidstring required

Unique identifier for this employee.

onboarding_statusstring

One of the "onboarding_status" enum values.