Jump to Content
Guides
API Reference
Changelog
API Status
API Policy
Gusto Security
v2024-03-01
v2024-04-01
v2025-06-15
v2025-11-15
v2026-02-01
API Reference
v2024-03-01
Guides
API Reference
Changelog
API Status
API Policy
Gusto Security
What's new in v2024-03-01
All
Pages
Start typing to search…
These docs are for v2024-03-01. Click to read the latest docs for v2025-11-15.
JUMP TO
Versions
What's new in v2024-03-01
Token
Introspection
Get info about the current access token
get
Refresh access token
post
Flows (Pre-built UI)
Flows
Create a flow
post
Companies
Companies
Create a partner managed company
post
Get a company
get
Update a company
put
Migrate company to embedded payroll
put
Accept terms of service for a company user
post
Retrieve terms of service status for a company user
post
Create an admin for the company
post
Get all the admins at a company
get
Get the company's onboarding status
get
Finish company onboarding
put
Get the custom fields of a company
get
Get suspensions for this company
get
Suspend a company's account
post
Locations
Create a company location
post
Get company locations
get
Get a location
get
Update a location
put
Get minimum wages for a location
get
Bank Accounts
Create a company bank account
post
Get all company bank accounts
get
Verify a company bank account
put
Create a bank account from a plaid processor token
post
Payment Configs
Get a company's payment configs
get
Update a company's payment configs
put
Company Forms
Get all company forms
get
Get a company form
get
Get a company form pdf
get
Sign a company form
put
Company Benefits
Create a company benefit
post
Get benefits for a company
get
Get a company benefit
get
Update a company benefit
put
Delete a company benefit
del
Get all benefits supported by Gusto
get
Get a supported benefit by ID
get
Get company benefit summary by company benefit id.
get
Get all employee benefits for a company benefit
get
Bulk update employee benefits for a company benefit
put
Get benefit fields requirements by ID
get
Federal Tax Details
Get Federal Tax Details
get
Update Federal Tax Details
put
Industry Selection
Get a company industry selection
get
Update a company industry selection
put
Signatories
Create a signatory
post
Get all company signatories
get
Invite a signatory
post
Update a signatory
put
Delete a signatory
del
Tax Requirements
Get State Tax Requirements
get
Update State Tax Requirements
put
Get All Tax Requirement States
get
Departments
Create a department
post
Get all departments of a company
get
Get a department
get
Update a department
put
Delete a department
del
Add people to a department
put
Remove people from a department
put
Company Attachment
Get Company Attachment Details
get
Get a temporary url to download the Company Attachment file
get
Get List of Company Attachments
get
Create Company Attachment and Upload File
post
W2 Employees
Employees
Create an employee
post
Get employees of a company
get
Create a historical employee
post
Get employee payment details for a company
get
Update a historical employee
put
Get an employee
get
Update an employee
put
Delete an onboarding employee
del
Get an employee's custom fields
get
Update an employee's onboarding documents config
put
Get the employee's onboarding status
get
Update the employee's onboarding status
put
Get employee time off activities
get
Employee Tax Setup
Get an employee's federal taxes
get
Update an employee's federal taxes
put
Get an employee's state taxes
get
Update an employee's state taxes
put
Employee Payment Method
Create an employee bank account
post
Get all employee bank accounts
get
Delete an employee bank account
del
Update an employee bank account
put
Get an employee's payment method
get
Update an employee's payment method
put
Employee Employments
Create an employee termination
post
Get terminations for an employee
get
Delete an employee termination
del
Update an employee termination
put
Create an employee rehire
post
Update an employee rehire
put
Get an employee rehire
get
Delete an employee rehire
del
Get employment history for an employee
get
Employee Addresses
Get an employee's home addresses
get
Create an employee's home address
post
Get an employee's home address
get
Update an employee's home address
put
Delete an employee's home address
del
Get an employee's work addresses
get
Create an employee work address
post
Get an employee work address
get
Update an employee work address
put
Delete an employee's work address
del
Jobs and Compensations
Create a job
post
Get jobs for an employee
get
Get a job
get
Update a job
put
Delete an individual job
del
Get compensations for a job
get
Create a compensation
post
Get a compensation
get
Update a compensation
put
Delete a compensation
del
I-9 Verification
Get an employee's I-9 authorization
get
Create or update an employee's I-9 authorization
put
Get an employee's I-9 verification document options
get
Get an employee's I-9 verification documents
get
Create an employee's I-9 authorization verification documents
put
Delete an employee's I-9 verification document
del
Employer sign an employee's Form I-9
put
Employee Forms
Generate a W2 form [DEMO]
post
Get all employee forms
get
Get an employee form
get
Get the employee form pdf
get
Sign an employee form
put
Employee Benefits
Create an employee benefit
post
Get all benefits for an employee
get
Get an employee benefit
get
Update an employee benefit
put
Delete an employee benefit
del
Get year-to-date benefit amounts from a different company
get
Create year-to-date benefit amounts from a different company
post
Garnishments
Create a garnishment
post
Get garnishments for an employee
get
Get a garnishment
get
Update a garnishment
put
Get child support garnishment data
get
1099 Contractors
Contractor Payment Groups
Create a contractor payment group
post
Get contractor payment groups for a company
get
Preview a contractor payment group
post
Fetch a contractor payment group
get
Cancel a contractor payment group
del
Fund a contractor payment group [DEMO]
put
Contractor Payment Method
Create a contractor bank account
post
Get all contractor bank accounts
get
Get a contractor's payment method
get
Update a contractor's payment method
put
Contractor Payments
Get a single contractor payment receipt
get
Fund a contractor payment [DEMO]
put
Create a contractor payment
post
Get contractor payments for a company
get
Get a single contractor payment
get
Cancel a contractor payment
del
Preview contractor payment debit date
get
Contractors
Create a contractor
post
Get contractors of a company
get
Get a contractor
get
Update a contractor
put
Delete a contractor
del
Get the contractor's onboarding status
get
Change the contractor's onboarding status
put
Get a contractor address
get
Update a contractor's address
put
Contractor Documents
Get all contractor documents
get
Get a contractor document
get
Get the contractor document pdf
get
Sign a contractor document
put
Contractor Forms
Get all contractor forms
get
Get a contractor form
get
Get the contractor form pdf
get
Generate a 1099 form [DEMO]
post
Payrolls
Pay Schedules
Create a new pay schedule
post
Get the pay schedules for a company
get
Preview pay schedule dates
get
Get a pay schedule
get
Update a pay schedule
put
Get pay periods for a company
get
Get termination pay periods for a company
get
Get pay schedule assignments for a company
get
Preview pay schedule assignments for a company
post
Assign pay schedules for a company
post
Earning Types
Create a custom earning type
post
Get all earning types for a company
get
Update an earning type
put
Deactivate an earning type
del
Payrolls
Create an off-cycle payroll
post
Get all payrolls for a company
get
Get approved payroll reversals
get
Get a single payroll
get
Update a payroll by ID
put
Delete a payroll
del
Prepare a payroll for update
put
Get a single payroll receipt
get
Get all payroll blockers for a company
get
Skip a payroll
post
Calculate gross up
post
Calculate a payroll
put
Submit payroll
put
Cancel a payroll
put
Get an employee pay stub (pdf)
get
Get an employee's pay stubs
get
Generate printable payroll checks (pdf)
post
External Payrolls
Create a new external payroll for a company
post
Get external payrolls for a company
get
Get an external payroll
get
Delete an external payroll
del
Update an external payroll
put
Get tax suggestions for an external payroll
get
Get tax liabilities
get
Update tax liabilities
put
Finalize tax liabilities options and convert into processed payrolls
put
Events
Events
Get all events
get
Webhooks
Webhooks
Create a webhook subscription
post
List webhook subscriptions
get
Update a webhook subscription
put
Get a webhook subscription
get
Delete a webhook subscription
del
Verify the webhook subscription
put
Request the webhook subscription verification_token
get
NOTIFICATIONS
Notifications
Get a notification's details
get
Time Off Policies
Time Off Policies
Calculate accruing time off hours
post
Get a time off policy
get
Update a time off policy
put
Get all time off policies
get
Create a time off policy
post
Add employees to a time off policy
put
Remove employees from a time off policy
put
Update employee time off hour balances
put
Deactivate a time off policy
put
Holiday Pay Policies
Holiday Pay Policies
Get a company's holiday pay policy
get
Create a holiday pay policy for a company
post
Update a company's holiday pay policy
put
Delete a company's holiday pay policy
del
Add employees to a company's holiday pay policy
put
Remove employees from a company's holiday pay policy
put
Preview a company's paid holidays
get
Generated Documents
Generated Documents
Get a generated document
get
Reports
Reports
Create a custom report
post
Create a general ledger report
post
Get a report
get
Get a report template
get
Invoices
Invoices
Retrieve invoicing data for companies
get
Recovery cases
Recovery Cases
Get all recovery cases for a company
get
Initiate a redebit for a recovery case
put
ACH Transactions
ACH Transactions
Get all ACH transactions for a company
get
Wire In Requests
Wire In Requests
Get a single Wire In Request
get
Submit a wire in request
put
Get all Wire In Requests for a company
get
Information Requests
Information Requests
Get all information requests for a company
get
Powered by
What's new in v2024-03-01
Ask AI
