Get the employee's onboarding status

get https://api.gusto-demo.com/v1/employees/{employee_id}/onboarding_status

Description

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

scope: employees:read

onboarding_status

Admin-facilitated onboarding

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

Employee self-onboarding

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

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)

Responses

404

Not Found

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

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.gusto-demo.com/v1/employees/employee_id/onboarding_status \
3
     --header 'X-Gusto-API-Version: 2024-04-01' \
4
     --header 'accept: application/json'


xxxxxxxxxx
68
}
1
{
2
  "uuid": "c44d66dc-c41b-4a60-9e25-5e93ff8583f2",
3
  "onboarding_status": "admin_onboarding_incomplete",
4
  "onboarding_steps": [
5
    {
6
      "title": "Personal details",
7
      "id": "personal_details",
8
      "required": true,
9
      "completed": false,
10
      "requirements": []
11
    },
12
    {
13
      "title": "Enter compensation details",
14
      "id": "compensation_details",
15
      "required": true,
16
      "completed": false,
17
      "requirements": []
18
    },
19
    {
20
      "title": "Add work address",
21
      "id": "add_work_address",
22
      "required": true,
23
      "completed": false,
24
      "requirements": []
25
    },

200Example response.