Documentation Index
Fetch the complete documentation index at: https://gusto-preview.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Form types
Onboarding
All Onboarding forms must be signed before an employee is paid using the PUT /v1/forms/{form_uuid}/sign endpoint. The following table provides an overview of the core forms required during onboarding, detailing each form’s purpose and whether the Gusto API supports it.| Document | Description | API Support |
|---|---|---|
| Federal W-4 | W-4 Employee Withholding Allowance: This document records the employee’s federal tax withholding allowance. | Yes |
| State W-4 | This document records the employee’s state tax withholding allowance. | No |
| Direct Deposit Authorization | This document authorizes Gusto to initiate debits and credits from a bank account in order to pay people. If payment_method = Direct Deposit, requires a signature. | Yes |
| I-9 | This document records a person’s authorization to work in the USA. | Yes |
| New Hire Report | This document reports new hires to the state where someone is employed (for example in California this is form DE-34) | Yes |
Ongoing
Employers can also collect details about employee paystubs using the GET /v1/payrolls/{payroll_uuid}/employees/{employee_uuid}/pay_stub endpoint. The following table outlines the paystub document retrieved via the API, including its components and support status.| Document | Description | API Support |
|---|---|---|
| Paystubs | Each paystub includes gross earnings, employee and employer taxes, employee benefits and deductions, employer contributions, time off taken and accrued, reimbursements, and your check amount. The taxes on your paystub may vary if your gross pay changes paycheck to paycheck. Your net pay is the remaining amount of gross pay after taxes, benefits, and any deductions are made. Due to PII and PHI you must deliver paystubs through a secure method. | Yes |
End of year
At year-end, employers must provide employees with annual tax documents. The table below lists the year-end forms available via the API, their descriptions, and their support status.| Document | Description | API Support |
|---|---|---|
| W-2 | This document reports annual wages, taxes, deductions, and other salary information. The information on your W-2 is needed when preparing your federal income tax return—Forms W-2 are available in mid-January for the previous calendar year. | Yes |
| W-2-C | An amended version of the W-2, should any changes occur after the original W-2 is issued. | Yes |
Retrieve forms
You can retrieve all supported forms via the API using the GET /v1/employees/{employee_uuid}/forms endpoint. Sample requestRetrieve a form in PDF
You can also retrieve the PDF file of the form. Use the GET /v1/forms/{form_id}/pdf endpoint to retrieve a company form in PDF: Sample requestSign an onboarding form
Use the PUT /v1/forms/{form_uuid}/sign endpoint to sign an onboarding form: Sample requestRetrieve an employee’s pay stub
Use the GET /v1/payrolls/{payroll_uuid}/employees/{employee_uuid}/pay_stub endpoint to retrieve an employee’s paystub, for a specific payroll, as application/pdf: Sample requestConfigure employee tax information I-9 employment verification