Gusto
Manage payroll, employees, and companies in Gusto
Integrate Gusto into your workflow. Access company information, list employees, retrieve employee details, view payroll runs, and manage pay schedules for your Gusto account.
List all companies accessible with the current Gusto OAuth token
| Parameter | Type | Required | Description |
|---|
| Parameter | Type | Description |
|---|
companies | array | List of accessible companies |
↳ uuid | string | Company UUID |
↳ name | string | Company legal name |
↳ trade_name | string | Trade name (DBA) |
↳ ein | string | Employer Identification Number |
↳ entity_type | string | Entity type (LLC, Corporation, etc.) |
↳ company_status | string | Company status (Approved, Not Approved, Suspended) |
count | number | Number of companies returned |
List all employees for a Gusto company
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | No description |
page | number | No | No description |
per | number | No | No description |
| Parameter | Type | Description |
|---|
employees | array | List of employees |
↳ uuid | string | Employee UUID |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ email | string | Work email |
↳ date_of_birth | string | Date of birth (YYYY-MM-DD) |
↳ hire_date | string | Hire date (YYYY-MM-DD) |
↳ termination_date | string | Termination date (YYYY-MM-DD) |
↳ department | string | Department |
↳ title | string | Job title |
count | number | Number of employees returned |
Get a specific Gusto employee by UUID with full details
| Parameter | Type | Required | Description |
|---|
employeeId | string | Yes | No description |
| Parameter | Type | Description |
|---|
uuid | string | Employee UUID |
first_name | string | First name |
last_name | string | Last name |
email | string | Work email |
date_of_birth | string | Date of birth (YYYY-MM-DD) |
hire_date | string | Hire date (YYYY-MM-DD) |
termination_date | string | Termination date (YYYY-MM-DD) |
department | string | Department |
title | string | Job title |
ssn | string | SSN (last 4 digits masked) |
home_address | object | Home address |
jobs | array | Jobs held by the employee |
↳ uuid | string | Job UUID |
↳ title | string | Job title |
↳ compensation_uuid | string | Compensation UUID |
List payrolls for a Gusto company with optional date range filtering
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | No description |
processed | boolean | No | No description |
start_date | string | No | No description |
end_date | string | No | No description |
| Parameter | Type | Description |
|---|
payrolls | array | List of payrolls |
↳ payroll_uuid | string | Payroll UUID |
↳ company_uuid | string | Company UUID |
↳ processed | boolean | Whether payroll has been processed |
↳ processed_date | string | Processing date (YYYY-MM-DD) |
↳ check_date | string | Check date (YYYY-MM-DD) |
↳ start_date | string | Pay period start (YYYY-MM-DD) |
↳ end_date | string | Pay period end (YYYY-MM-DD) |
↳ totals | object | Payroll totals breakdown |
count | number | Number of payrolls returned |
List pay schedules for a Gusto company
| Parameter | Type | Required | Description |
|---|
companyId | string | Yes | No description |
| Parameter | Type | Description |
|---|
pay_schedules | array | List of pay schedules |
↳ uuid | string | Pay schedule UUID |
↳ frequency | string | Pay frequency (Weekly, Biweekly, Semimonthly, Monthly) |
↳ anchor_pay_date | string | Anchor pay date (YYYY-MM-DD) |
↳ anchor_end_of_pay_period | string | Anchor end of pay period (YYYY-MM-DD) |
↳ day_1 | number | First pay day of month (for Semimonthly) |
↳ day_2 | number | Second pay day of month (for Semimonthly) |
↳ name | string | Pay schedule name |
↳ active | boolean | Whether the schedule is active |
count | number | Number of pay schedules returned |
