Modern payroll, benefits, and HR management platform for small and medium businesses
Modern payroll, benefits, and HR management platform for small and medium businesses On Nagent, Gusto is exposed as a fully-configurable human resources integration that any agent can call — 192 actions, and OAuth authentication. No code is required to wire Gusto into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Gusto to automate the kinds of tasks human resources teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Gusto into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Gusto, with input parameters and output schema. Drop these into any step of an agent built in Helix.
GUSTO_ADD_EMPLOYEES_TO_HOLIDAY_PAY_POLICYTool to add employees to a company's holiday pay policy in Gusto. Use when you need to add one or more employees to the holiday pay policy scope.
Input parameters
The current version of the holiday pay policy object. Required for optimistic locking. See the versioning guide for information on how to use this field.
List of employees to add to the holiday pay policy. Each employee is identified by their UUID.
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_ADD_EMPLOYEES_TO_TIME_OFF_POLICYTool to add employees to a time off policy in Gusto. Use when you need to assign employees to an existing vacation or sick leave policy. Employees must have at least one job to be added. Accepts starting balances for non-unlimited policies.
Input parameters
List of employees to add to the time off policy. Each employee must have at least one job. You can optionally specify a starting balance for non-unlimited policies.
The UUID of the time off policy to add employees to
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_ADD_PEOPLE_TO_DEPARTMENTTool to add employees and contractors to a department in Gusto. Use when you need to assign people to a specific department for organizational structure.
Input parameters
The current version of the department object. See the versioning guide for information on how to use this field for optimistic locking.
Array of employees to add to the department. Each employee is specified by their UUID.
Array of contractors to add to the department. Each contractor is specified by their UUID.
The UUID of the department to add people to
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_ASSIGN_PAY_SCHEDULESTool to assign employees to pay schedules in Gusto. Use when you need to set up or update which pay schedule employees follow. For single assignments, provide default_pay_schedule_uuid. For by_employee or by_department assignments, use partial_assignment=true for partial updates or false for full assignments.
Input parameters
The pay schedule assignment type. Use 'single' to assign one default schedule to all employees, 'by_employee' to assign specific schedules to individual employees, 'by_department' to assign schedules by department, or 'hourly_salaried' to assign different schedules for hourly vs salaried employees.
List of employees and their pay schedules. Used when type is 'by_employee'.
The UUID of the company.
List of departments and their pay schedules. Used when type is 'by_department'.
Indicates whether the request provides pay schedule assignments for a partial list of employees or departments of the company. Set to true for partial assignments (only some employees or departments at a time) and false for full assignments (all employees or departments). By default, this is set to false.
Pay schedule UUID for hourly employees. Used when type is 'hourly_salaried'.
Default pay schedule UUID for employees. Required when type is 'single', optional for other types as a fallback schedule.
Pay schedule UUID for salaried employees. Used when type is 'hourly_salaried'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CALCULATE_ACCRUING_TIME_OFF_HOURSTool to calculate accruing time off hours for an employee based on hours worked and used in a pay period. Returns a list of accrued hours for each time off policy associated with the employee, factoring in the policy's accrual method (per hour worked, per hour paid, with/without overtime).
Input parameters
The UUID of the payroll
The UUID of the employee
Paid time off hours used in this pay period. Format: decimal string (e.g., '0.0')
Sick hours used in this pay period. Format: decimal string (e.g., '0.0')
Regular hours worked in this pay period. Format: decimal string (e.g., '40.0')
Overtime hours worked in this pay period. Format: decimal string (e.g., '5.0')
Double overtime hours worked in this pay period. Format: decimal string
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_ADMINTool to create a new admin for a Gusto company. Use when you need to add administrative access to a company account. If the email matches an existing user, creates an admin account for the current user, otherwise creates a new user.
Input parameters
The email of the admin for Gusto's system. If the email matches an existing user, this will create an admin account for them.
The last name of the admin.
The UUID of the company to create the admin for.
The first name of the admin.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_COMPANIES_TIME_TRACKING_TIME_SHEETSTool to create a time sheet for an employee or contractor in Gusto. Use when you need to record work hours for payroll or time tracking purposes. Requires entity details, job information, and shift times.
Input parameters
Optional notes or comments about the time sheet
The UUID of the job associated with this time sheet
The time zone for the time sheet. Should be a valid IANA time zone identifier (e.g., 'America/New_York', 'America/Los_Angeles', 'UTC')
The type of entity. Must be either 'Employee' or 'Contractor'
The UUID of the entity (employee or contractor) for whom the time sheet is being created
The UUID of the company
Total break time in minutes during the shift. If not provided, defaults to 0
The end time of the shift in ISO 8601 format with timezone (e.g., '2025-01-06T17:00:00Z')
The start time of the shift in ISO 8601 format with timezone (e.g., '2025-01-06T09:00:00Z')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_COMPANY_BANK_ACCOUNTTool to create a company bank account in Gusto. Use when you need to add a new bank account for payroll processing.
Input parameters
The UUID of the company
The bank account type. Must be either 'Checking' or 'Savings'
The bank account number
The bank routing number
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_COMPANY_BENEFITTool to create a company benefit in Gusto. Use when you need to add a new benefit offering (e.g., medical insurance, retirement plan) for a company.
Input parameters
Whether this benefit is active for employee participation.
The UUID of the company
The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like 'Kaiser Permanente' or 'Blue Cross/Blue Shield'.
The ID of the benefit to which the company benefit belongs.
Catch-up contribution type for 401(k) and 403(b) benefits
Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to third party sick pay benefits.
Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_COMPANY_LOCATIONTool to create a company location in Gusto. Use when you need to add a new address for a company (mailing, filing, or work location).
Input parameters
ZIP code. Must be a valid US zip (e.g. 12345 or 12345-6789).
City name
State code (e.g. CA). Must be a valid two-letter state code.
Country code. Defaults to USA.
Street address line 1
Street address line 2 (optional)
The UUID of the company
Phone number. Must be exactly 10 digits (no spaces, dashes, or parentheses).
Specify if this location is the company's filing address
Specify if this location is the company's mailing address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_COMPANY_SIGNATORYTool to create a new signatory for a Gusto company. Use when you need to add an authorized signatory who can sign company forms and documents.
Input parameters
Social Security Number of the signatory in XXX-XX-XXXX format
The email address of the signatory
The phone number of the signatory
The job title of the signatory
The date of birth of the signatory in YYYY-MM-DD format
The last name of the signatory
The first name of the signatory
The UUID of the company to create the signatory for
The signatory's home address
The middle initial of the signatory
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_CONTRACTORTool to create an individual or business contractor in Gusto. Use when you need to add a new contractor to a company's payroll system. For individual contractors, first_name and last_name are required; for business contractors, business_name is required. Hourly contractors require hourly_rate.
Input parameters
The Federal Employer Identification Number of the contractor business. This attribute is optional for 'Business' contractors and will be ignored for 'Individual' contractors.
The Social Security Number of the individual contractor (9 digits, no dashes). This attribute is optional for 'Individual' contractors and will be ignored for 'Business' contractors.
The contractor's type, either 'Individual' or 'Business'. Required field.
The contractor's email address. This attribute is optional for 'Individual' contractors and will be ignored for 'Business' contractors.
The status of the contractor with the company. Defaults to true if not specified.
The contractor's last name. This attribute is required for 'Individual' contractors and will be ignored for 'Business' contractors.
The contractor's wage type, either 'Fixed' or 'Hourly'. Required field.
The UUID of the company to create the contractor for. This is the unique identifier for the company in Gusto (e.g., '42421951-8b1f-46ef-967d-014ffaaf48d9').
The contractor's first name. This attribute is required for 'Individual' contractors and will be ignored for 'Business' contractors.
The contractor's start date in YYYY-MM-DD format. Required field.
State where the contractor will be conducting the majority of their work for the company. This value is used when generating the new hire report. Use two-letter state codes (e.g., 'CA', 'NY').
The contractor's hourly rate. This attribute is required if the wage_type is 'Hourly'. Must be a numeric string (e.g., '50.00').
The name of the contractor business. This attribute is required for 'Business' contractors and will be ignored for 'Individual' contractors.
The contractor's middle initial. This attribute is optional for 'Individual' contractors and will be ignored for 'Business' contractors.
If true, the contractor is expected to self-onboard. If false, the payroll admin is expected to enter the contractor's onboarding information.
The boolean flag indicating whether Gusto will file a new hire report for the contractor.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_CONTRACTOR_BANK_ACCOUNTTool to create a contractor bank account in Gusto. Use when you need to add a bank account for contractor payments. Note: Only one bank account per contractor is supported; using this endpoint on a contractor who already has a bank account will replace it.
Input parameters
Name for the bank account (e.g., 'Main Checking Account'). This is used to identify the bank account.
The bank account type. Must be either 'Checking' or 'Savings'. This determines how the account is classified.
The UUID of the contractor to create the bank account for. This is the unique identifier for the contractor in Gusto (e.g., 'c44ce78a-47d9-4096-999b-4df2f3258483').
The bank account number. This is the contractor's bank account number for payments.
The bank account's routing number (9 digits). This is the ABA routing number used to identify the bank.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_DEPARTMENTTool to create a new department in a Gusto company. Use when you need to add a new department for organizational structure.
Input parameters
The title/name of the department
The UUID of the company to create the department for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EARNING_TYPESTool to create a custom earning type for a company in Gusto. If an inactive earning type exists with the same name, this will reactivate it instead of creating a new one.
Input parameters
The name of the custom earning type.
The UUID of the company where the earning type will be created.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EMPLOYEETool to create a new employee in Gusto. Use when you need to add a new employee to a company's payroll system.
Input parameters
Social Security Number of the employee (9 digits, no dashes)
The employee's personal email address. Required if self_onboarding is true
Last name of the employee
The UUID of the company to create the employee for
First name of the employee
The employee's work email address
Date of birth of the employee in YYYY-MM-DD format
Middle initial of the employee
If true, employee is expected to self-onboard. If false, payroll admin is expected to enter the employee's onboarding information
Preferred first name of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EMPLOYEE_BANK_ACCOUNTTool to create an employee bank account in Gusto. Use when you need to add a new bank account for an employee. Note that creating an employee bank account will also update the employee's payment method.
Input parameters
Name for the bank account
The UUID of the employee
The bank account type. Must be either 'Checking' or 'Savings'
The bank account number
The bank account's routing number
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EMPLOYEE_BENEFITTool to enroll an employee in a company benefit in Gusto. Use when you need to add a benefit enrollment for an employee, specifying deductions, contributions, and coverage details.
Input parameters
Whether the employee benefit is active.
Whether the employee should use a benefit's 'catch up' rate. Only Roth 401k and 401k benefits use this value for employees over 50.
Whether the company contribution is elective (aka 'matching'). For 'tiered', 'elective_amount', and 'elective_percentage' contribution types this is ignored and assumed to be true.
The UUID of the employee to enroll in the benefit.
Contribution configuration object.
Benefit limit options for HSA and Dependent Care FSA.
The date the employee benefit will start, in YYYY-MM-DD format. If not provided, the API will use a default date.
The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
The date the employee benefit will expire, in YYYY-MM-DD format. A null value indicates the benefit will not expire.
The amount to be deducted, per pay period, from the employee's pay.
The UUID of the company benefit to enroll the employee in.
The amount to be paid, per pay period, by the company.
Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.
The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.
Options for deduction tax impact.
The maximum employee deduction amount per year. A null value signifies no limit.
The maximum company contribution amount per year. A null value signifies no limit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EMPLOYEE_REHIRETool to create an employee rehire in Gusto. Use when an employee is scheduled to return to the company after being terminated or dismissed. Requires the employee UUID, effective return date, work location, and whether to file a new hire report.
Input parameters
The UUID of the employee to rehire
The day when the employee returns to work in YYYY-MM-DD format
Employment status for the rehired employee.
The uuid of the employee's work location
The boolean flag indicating whether Gusto will file a new hire report for the employee
Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EMPLOYEE_WORK_ADDRESSTool to create an employee's work address in Gusto. Use when you need to assign an employee to a specific company location with an effective date.
Input parameters
The UUID of the employee
Reference to a company location UUID
Date the employee began working at the company location in YYYY-MM-DD format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_EMPLOYEE_YTD_BENEFIT_AMOUNTS_FROM_OTHER_COMPANYTool to create year-to-date benefit amounts from a different company for an employee. Use when you need to record prior YTD benefit contributions and deductions from a previous employer.
Input parameters
The tax year for which this amount applies
The UUID of the benefit
The UUID of the employee
The benefit type supported by Gusto
The year-to-date employee deduction made outside the current company
The year-to-date company contribution made outside the current company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_FLOWSTool to generate a link to access a pre-built workflow in Gusto white-label UI. Use when you need to create onboarding flows, employee setup flows, or other company workflows. For security, all generated flows expire within 1 hour of inactivity or 24 hours from creation time.
Input parameters
Optional configuration object that varies based on the flow_type. This can contain arbitrary key-value pairs specific to the flow being generated.
The type of flow to generate. Multiple flow types can be combined by separating them with commas (e.g., 'add_addresses,add_employees,sign_all_forms').
Valid entity types for flows
UUID of the target entity applicable to the flow. This field is optional for company flows but may be required when entity_type is specified.
The UUID of the company to create the flow for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_GARNISHMENTSTool to create a garnishment (employee deduction) in Gusto. Use when you need to add fixed amounts or percentages deducted from an employee's pay, such as court-ordered payments, loan repayments, or other deductions.
Input parameters
The number of times to apply the garnishment. Ignored if recurring is true.
Whether or not this garnishment is currently active. Defaults to true.
The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. "8.00".
Whether the garnishment should recur indefinitely. Defaults to false.
The description of the garnishment.
The UUID of the employee
A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum.
Additional child support order details.
Whether the garnishment is court ordered.
The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. "200.00".
The specific type of garnishment for court ordered garnishments.
The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. "16.00".
Whether the amount should be treated as a percentage to be deducted per pay period. Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_HISTORICAL_EMPLOYEETool to create a historical employee in Gusto. Use when you need to add an employee who was previously dismissed from the company in the current year. Requires personal information (name, DOB, SSN), addresses (home and work location UUID), job hire date, and termination effective date.
Input parameters
The historical employee's job information including hire date.
Social Security Number of the historical employee (9 digits, no dashes, e.g., '987654321').
The employee's personal email address. If provided, the email address will be saved to the employee.
Last name of the historical employee (e.g., 'Smith').
First name of the historical employee (e.g., 'Jane').
The historical employee's termination information including effective date. The termination date must be in the current year.
The UUID of the company to create the historical employee for (e.g., '42421951-8b1f-46ef-967d-014ffaaf48d9'). This is the unique identifier for the company in Gusto.
The historical employee's home address including street, city, state, and zip code.
The historical employee's work address with location UUID reference.
Date of birth of the historical employee in YYYY-MM-DD format (e.g., '1988-03-22').
Middle initial of the historical employee (e.g., 'M').
Employee state tax information for workers' compensation.
Preferred first name of the historical employee (e.g., 'Janie').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_HOLIDAY_PAY_POLICYTool to create a holiday pay policy for a company in Gusto. Use when you need to define which federal holidays will be paid holidays for a company's employees.
Input parameters
The UUID of the company
An object containing federal holiday objects, each containing a boolean selected property. Specify which of the eleven supported federal holidays should be included in the holiday pay policy.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_JOBTool to create a job for an employee in Gusto. Use when you need to add a new job or position for an existing employee in the payroll system.
Input parameters
The job title
The date when the employee was hired or rehired for the job in YYYY-MM-DD format
The UUID of the employee to create the job for
Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)
The risk class code for workers' compensation in Washington state. Please visit Washington state's Risk Class page to learn more.
Whether the employee owns at least 2% of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_JOB_COMPENSATIONTool to create a compensation for a job in Gusto. Use when you need to set up payment details (rate, payment unit, FLSA status) for an employee's job.
Input parameters
The dollar amount paid per payment unit.
The UUID of the job to create compensation for.
The FLSA status for this compensation. Salaried ('Exempt') employees are paid a fixed salary every pay period. Salaried with overtime ('Salaried Nonexempt') employees are paid a fixed salary every pay period, and receive overtime pay when applicable. Hourly ('Nonexempt') employees are paid for the hours they work, and receive overtime pay when applicable. Commissioned employees ('Commission Only Exempt') earn wages based only on commission. Commissioned with overtime ('Commission Only Nonexempt') earn wages based on commission, and receive overtime pay when applicable. Owners ('Owner') are employees that own at least twenty percent of the company.
The unit accompanying the compensation rate. If the employee is an owner, rate should be 'Paycheck'.
The minimum wage records to apply to the compensation.
The date when the compensation takes effect in YYYY-MM-DD format.
Determines whether the compensation should be adjusted for minimum wage. Only applies to Nonexempt employees.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_PAYROLL_GENERAL_LEDGER_REPORTTool to create a general ledger report for a payroll with optional aggregation by job, department, or integration type. Use when you need accounting entries for a payroll run. The report is generated asynchronously; use the returned request_uuid to poll for completion and retrieve the JSON report.
Input parameters
The UUID of the payroll to generate the general ledger report for.
The breakdown of the report. Use 'default' for no split, 'job' to aggregate by job, 'department' to aggregate by department, or 'integration' to aggregate by integration type.
The kind of integration set up for the company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_PAY_SCHEDULES_ASSIGNMENT_PREVIEWTool to preview employee pay schedule assignment changes for a company. Use when you need to see how changing pay schedules will affect employees' pay periods and transition periods before applying the changes.
Input parameters
The pay schedule assignment type. Allowed values: by_employee, by_department, hourly_salaried, single.
List of employees and their pay schedules.
The UUID of the company.
List of departments and their pay schedules.
Indicates whether the request provides pay schedule assignments for a partial list of employees or departments of the company. By default, this is set to false.
Pay schedule for hourly employees.
Default pay schedule for employees.
Pay schedule for salaried employees.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_REPORTSTool to create a custom report for a company with custom columns, groupings, and filters. Use when you need to generate payroll, employee, or tax reports with specific data fields. The request_uuid in the response can be used to poll for the status and report URL upon completion. Report URLs are valid for 10 minutes.
Input parameters
List of columns to include in the report. Must contain at least one column.
End date of data to filter by in YYYY-MM-DD format.
The type of file to generate for the report.
How to group the data in the report. Must contain at least one grouping.
Start date of data to filter by in YYYY-MM-DD format.
The title of the report. If not provided, a default name will be used.
Whether to include subtotals and grand totals in the report.
The UUID of the company to create the report for.
List of employee UUIDs to filter by. If provided, only these employees will be included in the report.
Payment method filter options
Employment type filter options
List of department UUIDs to filter by. If provided, only employees in these departments will be included.
Employment status filter options
Dismissed end date of employees to filter by in YYYY-MM-DD format.
List of work address UUIDs to filter by. If provided, only employees at these addresses will be included.
Dismissed start date of employees to filter by in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_REPORTS_EMPLOYEES_ANNUAL_FICA_WAGETool to generate an annual FICA wage report for all employees in a company over a specified year range. Use when you need detailed wage information subject to Social Security and Medicare taxes for benefits integrations or compliance verification. The report is generated asynchronously; use the returned request_uuid to poll for completion.
Input parameters
The end year for the report. Must be the current year or earlier, and must be greater than or equal to start_year.
The UUID of the company to generate the report for.
The start year for the report. Must be 2011 or later.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_SECTION603_HIGH_EARNER_STATUSTool to create a Section 603 high earner status for an employee in Gusto. Use when you need to designate whether an employee qualifies as a high earner under Section 603 of the SECURE 2.0 Act for a specific year.
Input parameters
The UUID of the employee for whom to create the Section 603 high earner status.
The year for which this high earner status applies. Must be a valid year.
Whether the employee is classified as a high earner for Section 603 purposes. Section 603 of the SECURE 2.0 Act requires employees aged 50 or older whose prior-year FICA wages exceed the IRS threshold to have their catch-up contributions to pre-tax retirement benefits designated as post-tax contributions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_CREATE_TIME_OFF_POLICYTool to create a time off policy in Gusto for a company. Use when you need to set up vacation or sick leave policies with specific accrual methods and limits. The policy can be configured with accrual rates, maximum hours, carryover limits, and termination payout rules.
Input parameters
Name of the time off policy. This is a required field that identifies the policy (e.g., 'Test Vacation Policy', 'Sick Leave').
Boolean representing if a policy has completed configuration. Set to true when the policy setup is complete and ready to be activated.
The max number of hours an employee can accrue total. Represented as a float string (e.g., '160.0', '240.0').
Type of the time off policy. Must be either 'vacation' or 'sick'. This is a required field.
The rate at which the time off hours will accrue for an employee on the policy. Represented as a float string (e.g., '0.05', '40.0'). Required for hourly accrual methods.
The UUID of the company to create the time off policy for. This is the unique identifier for the company in Gusto (e.g., '42421951-8b1f-46ef-967d-014ffaaf48d9').
Policy time off accrual method. Determines how time off hours accrue for employees. This is a required field. Options include per_hour_worked, per_hour_paid, per_hour_worked_no_overtime, per_hour_paid_no_overtime, per_pay_period, or per_year.
The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float string (e.g., '1.0', '40.0').
The date the policy resets. Format MM-DD (e.g., '01-01' for January 1st, '07-01' for July 1st).
The max number of hours an employee can carryover from one year to the next. Represented as a float string (e.g., '40.0', '80.0').
Boolean representing if an employee's accrued time off hours will be paid out on termination. Set to true if unused hours should be paid when an employee leaves.
The max number of hours an employee can accrue in a year. Represented as a float string (e.g., '120.0', '200.0').
Number of days before an employee on the policy will begin accruing time off hours. If not specified, employees start accruing immediately.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DEACTIVATE_EARNING_TYPETool to deactivate an earning type for a company. Use when you need to remove or disable an earning type from a company's payroll configuration.
Input parameters
The UUID of the company
The UUID of the earning type to deactivate
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DEACTIVATE_TIME_OFF_POLICYTool to deactivate a time off policy in Gusto. Use when you need to disable or remove a vacation or sick leave policy from active use. Note: The policy cannot be deactivated if there are pending time off requests.
Input parameters
The UUID of the time off policy to deactivate. This is the unique identifier for the policy in Gusto (e.g., 'e9042ea2-63e7-40d5-b4e0-dbc8b650e904').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_COMPANIE_BANK_ACCOUNTSTool to disable a company bank account in Gusto. Use when you need to deactivate a bank account for a company. A bank account cannot be disabled if it is used for any unprocessed payments.
Input parameters
The UUID of the company
The UUID of the company bank account to disable
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_COMPANY_HOLIDAY_PAY_POLICYTool to delete a company's holiday pay policy in Gusto. Use when you need to remove the holiday pay policy for a company.
Input parameters
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_COMPENSATIONTool to delete a compensation by its UUID. Use when you need to remove a compensation record from Gusto.
Input parameters
The UUID of the compensation to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_CONTRACTORTool to delete a contractor from Gusto. Use when you need to permanently remove a contractor from the system.
Input parameters
The UUID of the contractor to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_DEPARTMENTTool to delete a department in Gusto. Use when you need to permanently remove a department. All employees and contractors must be removed from the department before deletion.
Input parameters
The UUID of the department to delete. Note: You cannot delete a department until all employees and contractors have been removed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_EMPLOYEETool to delete an onboarding employee from Gusto. Use when you need to remove an employee who has not yet been onboarded.
Input parameters
The UUID of the employee to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_EMPLOYEE_BANK_ACCOUNTTool to delete an employee bank account in Gusto. Use when you need to remove a bank account from an employee's profile.
Input parameters
The UUID of the employee
The UUID of the bank account
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_EMPLOYEE_BENEFITTool to delete an employee benefit by its UUID. Use when you need to remove an employee's enrollment in a specific benefit from Gusto.
Input parameters
The UUID of the employee benefit to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_EMPLOYEE_HOME_ADDRESSTool to delete an employee's home address in Gusto. Use when you need to remove a home address from an employee's profile.
Input parameters
The UUID of the home address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_EMPLOYEE_TERMINATIONTool to delete an employee termination in Gusto. Use when you need to remove a pending termination for an employee.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_I9_AUTHORIZATION_DOCUMENTTool to delete an employee's I-9 verification document from Gusto. Use when removing documents provided to verify identity and work authorization in the United States.
Input parameters
The UUID of the I-9 verification document to delete
The UUID of the employee whose I-9 document is being deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_JOBTool to delete an individual job from Gusto. Use when you need to remove a job by its UUID.
Input parameters
The UUID of the job to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_TIME_TRACKING_TIME_SHEETTool to delete a time sheet from Gusto time tracking. Use when you need to permanently remove a time sheet from the system.
Input parameters
API version parameter for the request
The unique identifier for the specific time sheet to be removed
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DELETE_WORK_ADDRESSTool to delete an employee's work address from Gusto. Use when you need to remove a work address by its UUID.
Input parameters
The UUID of the work address to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DOWNLOAD_EMPLOYEE_FORMS_PDFTool to get the link to an employee form PDF. Use when you need to retrieve or download a specific employee form document by providing the employee UUID and form UUID.
Input parameters
The UUID of the form
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_DOWNLOAD_FORMS_PDFTool to get the link to a company form PDF. Use when you need to retrieve or download a specific company form document by providing the form UUID.
Input parameters
The UUID of the form
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_FINISH_COMPANY_ONBOARDINGTool to finish company onboarding in Gusto. Use when you need to mark a company's onboarding process as complete.
Input parameters
The UUID of the company to finish onboarding for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_BENEFITTool to retrieve a benefit supported by Gusto. Returns high-level information about a particular benefit type and its tax considerations.
Input parameters
The benefit type ID in Gusto. This is the unique identifier for a particular benefit type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANIES_DEPARTMENTSTool to retrieve all departments of a company from Gusto. Use when you need to get a list of all departments, including their employees and contractors.
Input parameters
The UUID of the company to retrieve departments for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANYTool to retrieve company details from Gusto by company UUID. Use when you need to get information about a specific company including status, locations, admins, and payroll settings.
Input parameters
The UUID of the company to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_ATTACHMENT_DOWNLOAD_URLTool to retrieve a temporary URL to download a company attachment file. Use when you need to access uploaded company documents or files.
Input parameters
The UUID of the company
The UUID of the company attachment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_BENEFITTool to retrieve a specific company benefit by its UUID. Use when you need to get detailed information about a company benefit, including employee participation if requested.
Input parameters
Include option for the request
The UUID of the company benefit to retrieve.
Whether to return employee benefits associated with the benefit. Set to true to include employee benefits in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_EARNING_TYPESTool to retrieve all earning types (default and custom) for a company. Use when you need to list available earning types that can be assigned to employees for payroll purposes.
Input parameters
The UUID of the company to retrieve earning types for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_HOLIDAY_PAY_POLICYTool to retrieve a company's holiday pay policy including which federal holidays are selected and which employees are covered. Use when you need to access holiday pay configuration for a company.
Input parameters
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_LOCATIONSTool to get all company locations. Use when you need to retrieve address information for all locations associated with a specific company.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_ONBOARDING_STATUSTool to retrieve a company's onboarding status from Gusto. Use when you need to check if a company has completed onboarding and view the status of individual onboarding steps.
Input parameters
The UUID of the company to retrieve onboarding status for.
Comma-delimited string of additional onboarding steps to include. Currently only supports the value "external_payroll".
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_REPORT_TEMPLATETool to get a report template for a company. Use when you need to retrieve the recommended columns and groupings for a specific report type.
Input parameters
The report type
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPANY_SUSPENSIONSTool to retrieve all suspension records for a company. Use when you need to check if a company's Gusto account has been suspended and view suspension details including dates, reasons, and tax reconciliation settings.
Input parameters
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_COMPENSATIONSTool to retrieve compensation details by compensation UUID. Use when you need information on how much is paid out for a job, including rate, payment unit, and FLSA status.
Input parameters
The UUID of the compensation to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTORTool to retrieve a specific contractor by UUID from Gusto. Use when you need to get detailed information about a contractor including their personal details, employment status, onboarding status, and payment information.
Input parameters
The UUID of the contractor to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTOR_ADDRESSTool to retrieve a contractor's address from Gusto. Use when you need to get the current address information for a contractor. The address is used to determine certain tax information and is geocoded to ensure validity.
Input parameters
The UUID of the contractor whose address you want to retrieve. This is the unique identifier for the contractor in Gusto.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTOR_BANK_ACCOUNTSTool to get all bank accounts for a specific contractor. Use when you need to retrieve bank account information including account type, routing numbers, and masked account numbers for a contractor.
Input parameters
The UUID of the contractor whose bank accounts you want to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTOR_DOCUMENTTool to retrieve a contractor document by UUID. Use when you need to get details about a specific contractor document including its title, description, signing status, and associated fields.
Input parameters
The UUID of the document
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTOR_DOCUMENT_PDFTool to retrieve the PDF download URL for a contractor document. Use when you need to access or download a specific contractor document by its UUID.
Input parameters
The UUID of the document to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTOR_PAYMENT_GROUPSTool to get contractor payment groups for a company. Use when you need to retrieve payment groups for contractors within a specific time period. Returns groups with submission and credit blockers but without individual contractor payments.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The time period for which to retrieve contractor payment groups. Defaults to today's date.
The UUID of the company
The time period for which to retrieve contractor payment groups. Defaults to 6 months ago.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_CONTRACTOR_PAYMENTSTool to retrieve contractor payments for a company within a specified date range. Use when you need to fetch payment information for contractors, optionally filtered by specific contractor or date grouping.
Input parameters
Number of objects per page. For majority of endpoints will default to 25.
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The end date for the time period to retrieve contractor payments. If left empty, defaults to today's date. Format: YYYY-MM-DD.
The UUID of the company.
The start date for the time period to retrieve contractor payments. Format: YYYY-MM-DD.
Display contractor payments results grouped by check date if set to true.
The UUID of the contractor. When specified, will load all payments for that contractor.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_DEPARTMENTTool to retrieve details of a specific department from Gusto by department UUID. Use when you need to get information about a specific department including its employees and contractors.
Input parameters
The UUID of the department to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEETool to retrieve detailed information about an employee by their UUID. Use when you need employee information including personal details, job information, compensation, benefits, and employment status.
Input parameters
Include the requested attribute(s) in the employee response. Options: 'custom_fields' for custom fields, 'portal_invitations' for portal invitation status. Multiple options can be provided.
The UUID of the employee to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_ALL_BENEFITSTool to get all benefits for a specific employee by their UUID. Use when you need to retrieve all benefit enrollments for an employee, including contribution amounts, deduction details, and coverage information.
Input parameters
Number of employee benefits per page. For majority of endpoints will default to 25. Use this to control the page size when paginating results.
The page number to retrieve. When unspecified, will load all objects unless endpoint forces pagination. Use this for paginated results.
Options for including additional data in the response.
The UUID of the employee to retrieve benefits for. This is a required identifier for the employee whose benefits you want to list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_BANK_ACCOUNTSTool to retrieve all bank accounts for a specific employee. Use when you need to view an employee's banking details for payroll processing or direct deposit setup.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_BENEFITTool to retrieve a specific employee benefit enrollment by UUID. Use when you need to get detailed information about an employee's enrollment in a company benefit, including contribution amounts, deduction details, and coverage information. Benefits containing PHI require the employee_benefits:read:phi scope.
Input parameters
The UUID of the employee benefit to retrieve. This is the unique identifier for the specific employee benefit enrollment record.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_FEDERAL_TAXESTool to retrieve an employee's federal tax withholding information including W4 details. Use when you need to access federal tax configuration for a specific employee. The response format varies based on whether the employee is using pre-2020 or 2020+ W4 form.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_FORMSTool to get a specific employee form by employee ID and form ID. Use when you need to retrieve details about a specific form for an employee, including tax forms and other employee documents.
Input parameters
The UUID of the form
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_JOBSTool to retrieve all jobs for a specific employee in Gusto. Use when you need to get job information including titles, locations, compensation details, and employment history for an employee.
Input parameters
Number of jobs per page. For majority of endpoints will default to 25.
The page number to retrieve. When unspecified, will load all jobs unless endpoint forces pagination.
Options for additional data to include in the response
The UUID of the employee whose jobs you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_PAYMENT_METHODTool to retrieve an employee's payment method configuration. Use when you need to view how employee payments are split across bank accounts or if they are paid by check.
Input parameters
The UUID of the employee whose payment method you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_PAY_STUBTool to retrieve an employee's pay stub for a specified payroll as a PDF file. Use when you need to download a pay stub document for a specific employee and payroll.
Input parameters
The UUID of the payroll.
The UUID of the employee.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_RECURRING_REIMBURSEMENTSTool to get all recurring reimbursements for an employee. Use when you need to retrieve recurring reimbursement information for a specific employee.
Input parameters
Number of recurring reimbursements per page. For majority of endpoints will default to 25. Use with page parameter for pagination.
The page number to retrieve. When unspecified, will load all recurring reimbursements unless endpoint forces pagination. Use for paginated results.
The UUID of the employee whose recurring reimbursements you want to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_EMPLOYEE_STATE_TAXESTool to retrieve an employee's state tax information including withholding details and state-specific questions. Use when you need to access state tax configuration for a specific employee.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_FEDERAL_TAX_DETAILSTool to retrieve federal tax details for a company including EIN verification status, tax payer type, filing form, and deposit schedule. Use when you need to access a company's federal tax configuration and IRS-related information.
Input parameters
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_FORMTool to get a company form by its UUID. Use when you need to retrieve details about a specific form including its type, title, year, quarter, and signing status.
Input parameters
The UUID of the form
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_GARNISHMENTTool to retrieve a garnishment (employee deduction) from Gusto by garnishment UUID. Use when you need to get details about fixed amounts or percentages deducted from an employee's pay, such as court-ordered payments for child support or back taxes.
Input parameters
The UUID of the garnishment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_HOME_ADDRESSTool to get an employee's home address by its UUID. Use when you need to retrieve specific address details for tax purposes or employee records.
Input parameters
The UUID of the home address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_JOBTool to retrieve a specific job by UUID in Gusto. Use when you need to get detailed job information including title, location, compensation details, and employment data for a specific job.
Input parameters
The UUID of the job to retrieve.
Options for additional data to include in the response
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_LOCATIONTool to retrieve a specific location by UUID. Use when you need to get detailed address information for a single location.
Input parameters
The UUID of the location
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_NOTIFICATIONTool to retrieve a notification's details by UUID from Gusto. Use when you need to get detailed information about a specific notification including its status, due date, and related resources.
Input parameters
The notification entity_uuid
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_PAYROLLTool to retrieve a single payroll by its UUID. Returns payroll details including employee compensations and totals if calculated or processed. Use when you need detailed information about a specific payroll run.
Input parameters
Number of objects per page. For majority of endpoints will default to 25. Maximum is 100 for this endpoint.
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
Include the requested attribute in the response. Multiple attributes can be specified.
Field to sort employee compensations by.
The UUID of the company.
The UUID of the payroll.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_PAYROLL_RECEIPTTool to retrieve a payroll receipt by payroll UUID. Returns payment details including employee compensations, taxes, and totals. Dollar amounts are returned as string representations of numeric decimals to the cent.
Input parameters
The UUID of the payroll to retrieve the receipt for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_PAY_SCHEDULETool to retrieve a specific pay schedule by its UUID. Use when you need detailed information about a particular pay schedule for a company.
Input parameters
The UUID of the company.
The UUID of the pay schedule.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_PEOPLE_BATCHESTool to retrieve the status and results of a people batch from Gusto. Use when you need to poll the batch processing status and retrieve results after submitting a people batch.
Input parameters
The UUID of the people batch to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_RECURRING_REIMBURSEMENTTool to get a recurring reimbursement by its UUID. Use when you need to retrieve details of a specific recurring reimbursement.
Input parameters
The UUID of the recurring reimbursement to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_REPORTSTool to get a company's report given the request_uuid. Returns the report request's status and, if complete, the report URL. Use when you need to check the status of a report generation request or retrieve the completed report URL.
Input parameters
The UUID of the request to generate a document. Generate document endpoints return request_uuids to be used with the GET generated document endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_SALARY_ESTIMATETool to retrieve a salary estimate for an S-Corp owner from Gusto. Use when you need to get details about a salary estimate calculation based on occupation, experience level, location, and business revenue.
Input parameters
The UUID of the salary estimate to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_STATE_TAX_REQUIREMENTSTool to retrieve state-specific tax requirements for a company in Gusto. Use when you need to access required tax configuration fields for a specific US state including withholding details, account numbers, and filing information.
Input parameters
Two-letter US state abbreviation (e.g., CA, NY, TX)
When true, return 'new' requirement sets with valid effective_from dates that are available to save new effective dated values
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_SUMMARY_COMPANY_BENEFITS_SUMMARYTool to retrieve summary benefit data for a specific company benefit. Returns aggregate contribution and deduction amounts for a given time period. Use when you need to analyze benefit costs, employee participation, or financial reporting for a specific company benefit.
Input parameters
Display detailed employee payroll item summary. Set to true to include per-employee breakdown with payroll-level details, or false/omit for aggregate company-level summary only.
The end date for which to retrieve company benefit summary in YYYY-MM-DD format. If left empty, defaults to today's date.
The start date for which to retrieve company benefit summary in YYYY-MM-DD format. If not provided, summary will cover all available data from the beginning.
The UUID of the company benefit to retrieve summary data for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_TAX_LIABILITIESTool to retrieve tax liabilities for a company's external payrolls. Use when you need to view tax liability selections, filing frequencies, and payment methods for external payroll processing.
Input parameters
The UUID of the company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_TIME_OFF_POLICYTool to retrieve a specific time off policy by UUID from Gusto. Use when you need to get detailed information about a time off policy including accrual rates, employee assignments, and policy configuration.
Input parameters
The UUID of the time off policy to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_TIME_TRACKING_TIME_SHEETTool to fetch a time sheet by UUID. Time sheets represent the time worked by an employee or contractor for a given time range with hours classified by pay classification (regular, overtime, or double overtime). Use when you need detailed information about a specific time sheet.
Input parameters
The UUID of the time sheet to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_TOKEN_INFOTool to retrieve scope and resource information associated with the current access token. Use when you need to verify token permissions or identify the authenticated user or company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_GET_WORK_ADDRESSTool to retrieve an employee work address by UUID. Use when you need to get the work location details for an employee, including the address, effective date, and active status.
Input parameters
The UUID of the work address to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_INVITE_SIGNATORYTool to invite a signatory with minimal information. Use when you need to create a signatory who can be invited to provide more information and complete identity verification to sign documents.
Input parameters
The email address of the signatory.
The title of the signatory.
The last name of the signatory.
The first name of the signatory.
The UUID of the company to invite the signatory for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_ACH_TRANSACTIONSTool to retrieve all ACH transactions for a company. Use when you need to view payment transactions, track payment statuses, or analyze financial movements for payroll and contractor payments.
Input parameters
Number of objects per page. For majority of endpoints will default to 25.
The page number to retrieve. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company whose ACH transactions you want to retrieve.
Optional filter to get ACH transactions for a specific payroll. When provided, only ACH transactions for this payroll will be returned.
Optional filter to get ACH transactions with a specific transaction type. Example: "Credit employee pay".
Payment direction enumeration.
Optional filter to get ACH transactions for a specific contractor payment. When provided, only ACH transactions for this contractor payment will be returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_ATTACHMENTSTool to retrieve a list of all attachments uploaded by a company. Use when you need to view or audit company documents and files. Requires the scope company_attachments:read.
Input parameters
The UUID of the company whose attachments to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_BENEFITSTool to retrieve all benefits supported by Gusto. Use when you need to discover available benefit types, their tax considerations, or determine which benefits can be created for companies.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_BENEFITS_REQUIREMENTSTool to retrieve field requirements for a specific benefit type. Use when you need to understand what fields are required, editable, or have specific constraints for enrolling employees in benefits.
Input parameters
The benefit type ID in Gusto
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANIE_CUSTOM_FIELDSTool to retrieve the custom fields configured for a company. Use when you need to know the schema of custom fields at the company level.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANIES_TIME_OFF_REQUESTSTool to retrieve all time off requests for a company in Gusto. Use when you need to view pending, approved, denied, or cancelled time off requests submitted by employees.
Input parameters
The UUID of the company to retrieve time off requests for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANY_BANK_ACCOUNTSTool to retrieve all bank accounts for a specific company. Currently, Gusto only supports a single default bank account per company. Use when you need to view company banking details for payroll processing.
Input parameters
The UUID of the company whose bank accounts you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANY_BENEFITSTool to retrieve all benefits offered by a company. Use when you need to list available company benefits, check benefit statuses, or see employee enrollment information. Company benefits represent the benefits that a company offers to employees and can be filtered by active status or benefit type.
Input parameters
Filter benefits by active status. Set to true to retrieve only active benefits (available for employee participation), false for inactive benefits, or omit to retrieve all benefits regardless of status.
The UUID of the company to retrieve benefits for. This is a required identifier for the company whose benefits you want to list.
Filter benefits by benefit type ID(s). Provide a single benefit type ID or a comma-separated list of benefit type IDs to filter results. Example: '5' for a single type or '5,105' for multiple types.
Include employee enrollment counts in the response. Set to true to return the number of employees enrolled in each benefit. When false or omitted, enrollment_count field will not be included in benefit objects.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANY_BENEFITS_CONTRIBUTION_EXCLUSIONSTool to retrieve all contributions for a given company benefit and whether they are excluded or not. Use when you need to check which contribution types are excluded from a specific benefit. Currently only works for 401-k and Roth 401-k benefit types.
Input parameters
The UUID of the company benefit to retrieve contribution exclusions for. This is a required identifier for the company benefit whose contribution exclusions you want to list. Currently this endpoint only works for 401-k and Roth 401-k benefit types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANY_BENEFITS_EMPLOYEE_BENEFITSTool to retrieve all employee benefits for a specific company benefit. Use when you need to see which employees are enrolled in a particular company benefit and their enrollment details. Returns employee-specific benefit information including contribution amounts, deduction percentages, and coverage details.
Input parameters
Number of employee benefits per page. For majority of endpoints will default to 25. Use this to control the page size when paginating results.
The page number to retrieve. When unspecified, will load all objects unless endpoint forces pagination. Use this for paginated results.
Options for including additional data in the response.
The UUID of the company benefit to retrieve employee benefits for. This is a required identifier for the company benefit whose employee enrollments you want to list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_COMPANY_FORMSTool to get a list of all company's forms. Use when you need to retrieve all forms associated with a specific company, including tax forms and other company documents.
Input parameters
Sort company forms. Options: name, year, quarter, draft, document_content_type, created_at (optionally with :asc or :desc suffix)
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_CONTRACTOR_DOCUMENTSTool to get all documents for a specific contractor in Gusto. Use when you need to retrieve contractor documents including tax forms, agreements, and other signed or unsigned documents with their details and status.
Input parameters
The UUID of the contractor whose documents you want to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_CONTRACTOR_FORMSTool to get a list of all contractor's forms. Use when you need to retrieve all forms associated with a specific contractor, including tax forms and other contractor documents.
Input parameters
The UUID of the contractor whose forms you want to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_CONTRACTOR_ONBOARDING_STATUSTool to retrieve a contractor's onboarding status from Gusto. Use when you need to check contractor onboarding progress and view completion status of required onboarding steps.
Input parameters
The UUID of the contractor to retrieve onboarding status for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_CONTRACTOR_PAYMENT_DETAILSTool to get payment details for contractors in a company, including their payment methods and bank account details for direct deposit. Use when you need to retrieve contractor payment information such as bank routing numbers, account details, or payment split configurations.
Input parameters
The UUID of the company. This identifies the company whose contractor payment details you want to retrieve.
Optional filter to get payment details for a specific contractor. When provided, the response will only include payment details for this contractor.
Optional filter to get payment details for contractors in a specific payment group. When provided, the response will only include payment details for contractors in this group.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_CONTRACTOR_PAYMENT_METHODTool to fetch a contractor's payment method configuration. Use when you need to retrieve how contractor payments are split across bank accounts or if they are paid by check.
Input parameters
The UUID of the contractor whose payment method you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_CONTRACTORSTool to get all contractors for a company including individuals and businesses. Use when you need to retrieve contractor information, filter by onboarding or termination status, or search for specific contractors by name.
Input parameters
Number of contractors per page. For majority of endpoints will default to 25. Use with page parameter for pagination.
The page number to retrieve. When unspecified, will load all contractors unless endpoint forces pagination. Use for paginated results.
Sort options for contractors
Filters contractors by those who have completed onboarding. Set to true to get only onboarded contractors, false for non-onboarded.
Filters contractors by those who have been or are scheduled to be dismissed. Set to true to include terminated contractors.
A string to search for in the contractor's names. Filters contractors by partial name match.
The UUID of the company whose contractors you want to retrieve
Filters contractors who are ready to work (onboarded AND active today). Set to true to get only contractors who are fully onboarded and currently active.
Filters contractors by those who have been dismissed and whose dismissal is in effect today. Excludes active and scheduled to be dismissed contractors.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYEE_CUSTOM_FIELDSTool to retrieve the custom fields configured for an employee. Use when you need to get the custom field values for a specific employee.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYEE_FORMSTool to get a list of all employee's forms. Use when you need to retrieve all forms associated with a specific employee, including tax forms and other employee documents.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYEE_HOME_ADDRESSESTool to get an employee's home addresses. The home address is used to determine certain tax information and supports effective dating and courtesy withholding. Use when you need to retrieve address information for tax purposes or employee records.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYEE_ONBOARDING_STATUSTool to retrieve an employee's onboarding status from Gusto. Use when you need to check the onboarding progress and completion status of required steps for a specific employee.
Input parameters
The UUID of the employee to retrieve onboarding status for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYEESTool to get all employees for a given company including onboarding, active, and terminated employees. Use when you need to retrieve employee information for a specific company.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
Optional subset of employees to fetch.
Include the requested attribute(s) in each employee response. Multiple options are comma separated.
Sort employees by field. Cannot be used with search_term. Options: created_at, name, onboarding_status
Filters employees by those who have completed onboarding
The UUID of the company
Filters employees by those who have been or are scheduled to be terminated
A string to search for in the object's names
Filter employees by a specific payroll
Filter employees by a specific primary work location
Filters employees who are ready to work (onboarded AND active today)
Filters employees by those who have been terminated and whose termination is in effect today (excludes active and scheduled to be terminated)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYEE_WORK_ADDRESSESTool to get all work addresses for a specific employee. Use when you need to retrieve address information for all work locations associated with an employee, including historical and active addresses.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_EMPLOYMENT_HISTORYTool to retrieve employment history for a given employee, including terminations and rehires. Use when you need to view the complete work history for a specific employee.
Input parameters
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_GARNISHMENTS_CHILD_SUPPORTTool to retrieve child support agency data including FIPS codes, payment requirements, and required attributes for each state. Use when you need to lookup agency-specific requirements before creating a child support garnishment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_INFORMATION_REQUESTSTool to fetch all information requests for a company in Gusto. Use when you need to retrieve pending, under review, or approved information requests that may be blocking payroll.
Input parameters
The UUID of the company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_JOBS_COMPENSATIONSTool to retrieve all compensations for a specific job in Gusto. Use when you need information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. By default returns only the current compensation.
Input parameters
Number of objects per page. For majority of endpoints will default to 25.
The page number to retrieve. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the job whose compensations you want to retrieve.
Options for additional data to include in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_MIGRATION_READINESSTool to check if a Gusto company is ready to be migrated to embedded payroll. Returns blockers and warnings for migration. Use this before attempting to migrate a company.
Input parameters
The UUID of the company to check migration readiness for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_MINIMUM_WAGESTool to get minimum wages for a specific location. Use when you need to retrieve minimum wage information for a location, optionally filtered by effective date.
Input parameters
The UUID of the location
Filter minimum wages by effective date. Format: YYYY-MM-DD
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_NOTIFICATIONSTool to retrieve all notifications relevant for a company. Returns notifications that can be filtered by status (open, expired, resolved). Use when you need to check pending actions, critical alerts, or payroll blockers for a company.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
Status of notification
The UUID of the company for which you would like to return notifications
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAID_HOLIDAYSTool to retrieve a company's paid holidays from Gusto. Use when you need to preview the paid holidays for a company based on their holiday pay policy.
Input parameters
If a year is passed, paid holidays for that year will be returned. Otherwise, paid holidays for the next three years will be returned.
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAYMENT_DETAILSTool to fetch payment details for employees in a company including payment methods and bank account details. Use when you need to retrieve employee payment information such as bank routing numbers, account details, or payment split configurations.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company
The UUID of a specific payroll to fetch payment details for employees on that payroll.
The UUID of a specific employee to fetch payment details for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAY_PERIODSTool to retrieve pay periods for a company. Pay periods are the foundation of payroll and are used for compensation, time & attendance, taxes, and expense reports. Use when you need to get pay period information for submitting payroll data.
Input parameters
The end date for filtering pay periods. Format: YYYY-MM-DD. If not provided, defaults to today's date.
The UUID of the company to retrieve pay periods for.
The start date for filtering pay periods. Format: YYYY-MM-DD. If not provided, defaults to 6 months ago.
Filter by payroll types: 'regular' and/or 'transition'. Multiple options are comma-separated (e.g., 'regular,transition'). If not provided, defaults to regular pay periods only.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAYROLL_BLOCKERSTool to retrieve all payroll blockers for a company. Returns reasons that prevent the company from running payrolls, or an empty list if no blockers exist. Use when you need to check if a company can run payroll or identify issues that need to be resolved before payroll processing.
Input parameters
The UUID of the company to retrieve payroll blockers for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAYROLL_REVERSALSTool to retrieve all approved payroll reversals for a company. Use when you need to view reversals that have been applied to previous payroll runs.
Input parameters
Number of objects per page. For majority of endpoints will default to 25.
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company to retrieve payroll reversals for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAY_SCHEDULESTool to retrieve all pay schedules for a company. Use when you need to get information about when employees work and when they should be paid for a specific company.
Input parameters
Number of objects per page. For majority of endpoints will default to 25.
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company to retrieve pay schedules for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAY_SCHEDULES_ASSIGNMENTSTool to retrieve the current pay schedule assignment for a company, including pay schedules and employee/department mappings. Use when you need to understand how pay schedules are assigned to employees and departments in a company.
Input parameters
The UUID of the company to retrieve pay schedule assignments for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAY_SCHEDULES_PREVIEWTool to preview pay schedule dates with specified parameters for the next 18 months. Use when you need to see upcoming pay dates, pay periods, and bank holidays for a proposed pay schedule configuration before creating it.
Input parameters
An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the 'Twice per month' and 'Monthly' frequencies. It will be null for pay schedules with other frequencies.
An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the 'Twice per month' frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, we will set the second pay date to the last day of the month. It will be null for pay schedules with other frequencies.
The frequency that employees on this pay schedule are paid with Gusto.
The UUID of the company to preview pay schedules for.
The first date that employees on this pay schedule are paid with Gusto. Format: YYYY-MM-DD
The last date of the first pay period. This can be the same date as the anchor pay date. Format: YYYY-MM-DD
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_PAY_STUBSTool to get an employee's pay stubs including payment details and amounts. Use when you need to retrieve pay stub information for a specific employee.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_RECOVERY_CASESTool to fetch all recovery cases for a company. Use when you need to retrieve recovery case information including status, outstanding amounts, and associated payroll or contractor payment details. Recovery cases track failed ACH transactions that require recovery.
Input parameters
The UUID of the company to retrieve recovery cases for. This is a required identifier for the company whose recovery cases you want to list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_SIGNATORIESTool to retrieve all company signatories. Use when you need to get signatory information for signing company forms and documents. Currently only a single signatory per company is supported.
Input parameters
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_TAX_REQUIREMENTSTool to retrieve all tax requirement states for a company. Use when you need to check which states have tax requirements and whether the company has completed setup for each state during onboarding.
Input parameters
The UUID of the company to retrieve tax requirements for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_TIME_OFF_ACTIVITIESTool to get employee time off activities for a specific time off type. Use when you need to view an employee's time off balance changes, accruals, and usage history.
Input parameters
The UUID of the employee
The time off type name you want to query data for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_TIME_OFF_POLICIESTool to retrieve all time off policies for a company. Use when you need to list available time off policies, check policy configurations, or see which employees are assigned to each policy.
Input parameters
The UUID of the company to retrieve time off policies for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_TIME_TRACKING_TIME_SHEETSTool to fetch all company's time sheets representing time worked by employees or contractors. Use when you need to retrieve time tracking data including regular, overtime, and double overtime hours for a given time range.
Input parameters
Number of objects per page. For majority of endpoints will default to 25
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_UNPROCESSED_TERMINATION_PAY_PERIODSTool to retrieve unprocessed termination pay periods for a company. Use when you need to view dismissal payrolls for past and future terminated employees.
Input parameters
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_WIRE_IN_REQUESTSTool to retrieve all Wire In Requests for a company. Use when you need to view wire transfer requests, track payment statuses, or manage incoming wire transfers for payroll and contractor payments.
Input parameters
The UUID of the company whose wire in requests you want to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_LIST_YTD_BENEFIT_AMOUNTS_FROM_DIFFERENT_COMPANYTool to retrieve year-to-date benefit amounts contributed at a different company for an employee. Returns benefit amounts for the requested tax year (defaults to current year if not specified). This endpoint only supports retrieving outside contributions for 401(k) benefits.
Input parameters
The tax year for which to retrieve YTD benefit amounts. Defaults to current year if not specified.
The UUID of the employee for whom to retrieve YTD benefit amounts from a different company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_REMOVE_HOLIDAY_PAY_POLICY_EMPLOYEESTool to remove employees from a company's holiday pay policy in Gusto. Use when you need to exclude specific employees from the holiday pay policy scope.
Input parameters
The current version of the holiday pay policy object for optimistic locking. See the versioning guide for information on how to use this field.
List of employee UUIDs to remove from the holiday pay policy scope
The UUID of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_REMOVE_PEOPLE_FROM_DEPARTMENTTool to remove employees and contractors from a department in Gusto. Use when you need to unassign people from a department.
Input parameters
The current version of the department object. See the versioning guide for information on how to use this field.
Array of employees to remove from the department. Each employee is identified by their UUID.
Array of contractors to remove from the department. Each contractor is identified by their UUID.
The UUID of the department to remove people from
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_REMOVE_TIME_OFF_POLICY_EMPLOYEESTool to remove employees from a time off policy in Gusto. Use when you need to exclude specific employees from a vacation or sick leave policy scope.
Input parameters
List of employees to remove from the time off policy scope. Each employee object must contain a uuid field.
The UUID of the time off policy
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_RETRIEVE_TERMS_OF_SERVICE_STATUSTool to retrieve the user acceptance status of Gusto Embedded Payroll's Terms of Service. Use when you need to check if a specific user has accepted the latest terms of service for a company.
Input parameters
The user's email address on Gusto. You can retrieve the user's email via company's /admins, /employees, /signatories, and /contractors endpoints.
The UUID of the company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_COMPANYTool to update a company in Gusto. Use when you need to change company settings, particularly the contractor_only flag to enable W-2 employee support.
Input parameters
The UUID of the company to update
Whether the company only supports contractors. Must be updated in order for the company to start supporting W-2 employees. Can only be updated from true to false. Note that updating this value will require additional onboarding steps to be completed in order for the company to support W-2 employees.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_COMPANY_BENEFIT_CONTRIBUTION_EXCLUSIONSTool to update contribution exclusions for a company benefit in Gusto. Use when you need to specify which contribution types should be excluded from a specific benefit. Currently only works for 401-k and Roth 401-k benefit types.
Input parameters
The UUID of the company benefit to update contribution exclusions for. Currently this endpoint only works for 401-k and Roth 401-k benefit types.
The list of contribution exclusions to update. Each entry specifies a contribution type and whether it should be excluded from the benefit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_COMPANY_BENEFITSTool to update an existing company benefit in Gusto. Use when you need to modify benefit details such as description, active status, or other attributes. Note that company benefits can be deactivated only when no employees are enrolled.
Input parameters
Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating.
The current version of the object. See the versioning guide for information on how to use this field. This is required for optimistic concurrency control.
The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like 'Kaiser Permanente' or 'Blue Cross/Blue Shield'.
Catch-up contribution type for 401(k) and 403(b) benefits
The UUID of the company benefit to update
Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to short-term and long-term disability benefits (different from voluntary disability).
Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to short-term and long-term disability benefits (different from voluntary disability).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_CONTRACTOR_ADDRESSTool to create or update a contractor's address in Gusto. Use when you need to set or modify the home address information for an existing contractor. Requires the contractor's UUID and the current version for optimistic locking.
Input parameters
The ZIP code of the contractor's address.
The city of the contractor's address.
The state of the contractor's address. Use two-letter state codes.
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
The first line of the contractor's address (street address).
The second line of the contractor's address (apartment, suite, etc.). This field is optional.
The UUID of the contractor whose address is being updated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_CONTRACTOR_PAYMENT_METHODTool to update a contractor's payment method in Gusto. Use when you need to change how a contractor receives payments (Check or Direct Deposit). For Direct Deposit, you'll need to configure bank account splits separately.
Input parameters
The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
The UUID of the contractor whose payment method is being updated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_DEPARTMENTTool to update a department in Gusto. Use when you need to modify department details like the title. Requires the current version for optimistic locking.
Input parameters
The title/name of the department
The current version of the object. See the versioning guide for information on how to use this field.
The UUID of the department to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EARNING_TYPETool to update an earning type in Gusto. Use when you need to modify the name of a custom earning type for a company.
Input parameters
The name of the custom earning type.
The UUID of the company.
The UUID of the earning type to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEETool to update an employee in Gusto. Use when you need to modify employee information such as name, email, SSN, or shareholder status. Requires the current version field for idempotency.
Input parameters
Social Security Number of the employee (9 digits, no dashes)
The employee's personal email address. This is provided to support syncing users between systems. You may not use this email address for any other purpose (e.g. marketing)
The current version of the employee. See the versioning guide for information on how to use this field for idempotency
Last name of the employee
First name of the employee
The employee's work email address. This is provided to support syncing users between systems. You may not use this email address for any other purpose (e.g. marketing)
The UUID of the employee to update
Date of birth of the employee in YYYY-MM-DD format
Middle initial of the employee
Preferred first name of the employee
Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_BANK_ACCOUNTTool to update an employee bank account in Gusto. Use when you need to modify existing employee bank account details.
Input parameters
Name for the bank account
The UUID of the employee
The bank account type. Must be either 'Checking' or 'Savings'
The bank account number
The bank account's routing number
The UUID of the bank account to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_BENEFITTool to update an individual employee benefit by its UUID in Gusto. Use when you need to modify benefit details like deduction amounts, company contributions, coverage, or dates for a specific employee's benefit enrollment. Requires the benefit UUID and version for optimistic locking.
Input parameters
Whether the employee benefit is active.
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
Whether the employee should use a benefit's 'catch up' rate. Only Roth 401k and 401k benefits use this value for employees over 50.
Whether the company contribution is elective (aka 'matching'). For 'tiered', 'elective_amount', and 'elective_percentage' contribution types this is ignored and assumed to be true.
Contribution configuration object.
Benefit limit options for HSA and Dependent Care FSA.
The date the employee benefit will start, in YYYY-MM-DD format.
The amount that the employee is insured for. Note: company contribution cannot be present if coverage amount is set.
The date the employee benefit will expire, in YYYY-MM-DD format. A null value indicates the benefit will not expire.
The amount to be deducted, per pay period, from the employee's pay.
The UUID of the employee benefit to update.
The amount to be paid, per pay period, by the company.
Whether the employee deduction amount should be treated as a percentage to be deducted from each payroll.
Whether the company contribution amount should be treated as a percentage to be deducted from each payroll.
The coverage amount as a multiple of the employee's salary. Only applicable for Group Term Life benefits. Note: cannot be set if coverage amount is also set.
Options for deduction tax impact.
The maximum employee deduction amount per year. A null value signifies no limit.
The maximum company contribution amount per year. A null value signifies no limit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_BENEFITSTool to bulk update or create employee benefits for a company benefit in Gusto. Use when you need to enroll employees in a benefit plan or modify existing enrollments.
Input parameters
List of employee benefits to create or update. Each entry must include employee_uuid and may include action ('create' or 'update').
The UUID of the company benefit for which employee benefits are being updated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_ONBOARDING_STATUSTool to update the onboarding status of an employee in Gusto. Use when you need to change an employee's progress through the onboarding process. Note that invalid status transitions will return a 422 error.
Input parameters
The UUID of the employee
The new onboarding status to set for the employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_PAYMENT_METHODTool to update an employee's payment method in Gusto. Use when you need to change how an employee receives payments (Check or Direct Deposit). For Direct Deposit, you must also specify split_by and splits to configure bank account distribution.
Input parameters
The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.
The list of bank account splits for Direct Deposit payments. Required if type is Direct Deposit. Each split defines how much of the payment goes to which bank account.
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
Describes how the payment will be split
The UUID of the employee whose payment method is being updated
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_REHIRETool to update an employee rehire in Gusto. Use when you need to modify the details of a pending rehire for a terminated employee.
Input parameters
The current version of the object. See the versioning guide for information on how to use this field for optimistic locking.
The UUID of the employee
The day when the employee returns to work in YYYY-MM-DD format
The employee's employment status.
The UUID of the employee's work location
The boolean flag indicating whether Gusto will file a new hire report for the employee
Whether the employee is a two percent shareholder of the company. This field only applies to companies with an S-Corp entity type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_EMPLOYEE_TERMINATIONTool to update an existing employee termination in Gusto. Use when you need to modify the effective date or payroll settings for a scheduled termination. Requires the current version for optimistic locking.
Input parameters
The current version of the termination object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
The UUID of the employee whose termination to update
The employee's last day of work in YYYY-MM-DD format
If true, the employee should receive their final wages via an off-cycle payroll. If false, they should receive their final wages on their current pay schedule
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_FEDERAL_TAX_DETAILSTool to update federal tax details for a company in Gusto. Use when you need to update attributes relevant for federal taxes such as EIN, filing form, legal name, tax payer type, or S-Corporation election.
Input parameters
The EIN (Employer Identification Number) of the company.
The current version of the object. Required for optimistic locking. See the versioning guide for information on how to use this field.
The UUID of the company whose federal tax details are being updated.
The legal name of the company.
Federal tax filing form type.
Tax entity type for the company.
Whether this company should be taxed as an S-Corporation. Applicable for S-Corporation, C-Corporation, and LLC tax payer types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_FEDERAL_TAXESTool to update federal tax information for an employee in Gusto. Use when you need to update W-4 form data including filing status, withholdings, and allowances. The response structure varies based on whether pre-2020 or 2020+ W-4 data is being updated.
Input parameters
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
Only applicable when w4_data_type is 'rev_2020_w4'. Whether the employee has multiple jobs or the spouse works.
Only applicable when w4_data_type is 'rev_2020_w4'. Deductions other than the standard deduction.
Only applicable when w4_data_type is 'rev_2020_w4'. Other income not from jobs (e.g., interest, dividends).
The type of W-4 form data being submitted. Use 'pre_2020_w4' for pre-2020 W-4 forms or 'rev_2020_w4' for 2020 and later W-4 forms.
The UUID of the employee whose federal taxes are being updated.
The employee's federal tax filing status (e.g., 'Single', 'Married', 'Married_filing_separately', 'Head_of_household').
Only applicable when w4_data_type is 'rev_2020_w4'. The total amount for dependents claimed on the W-4.
Only applicable when w4_data_type is 'rev_2020_w4'. Extra amount to withhold from each paycheck.
Only applicable when w4_data_type is 'pre_2020_w4'. The additional amount to withhold from each paycheck.
Only applicable when w4_data_type is 'pre_2020_w4'. The number of federal withholding allowances claimed on the W-4.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_GARNISHMENTTool to update an existing garnishment in Gusto. Use when you need to modify garnishment details such as amount, description, or child support information. Requires the garnishment UUID and the current version for optimistic locking.
Input parameters
The number of times to apply the garnishment. Ignored if recurring is true.
Whether or not this garnishment is currently active. Default is true.
The amount of the garnishment. Either a percentage or a fixed dollar amount. Represented as a float, e.g. '8.00'.
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
Whether the garnishment should recur indefinitely. Default is false.
The description of the garnishment.
A maximum total deduction for the lifetime of this garnishment. A null value indicates no maximum. Represented as a float.
Child support order details for garnishments.
Whether the garnishment is court ordered.
The maximum deduction per annum. A null value indicates no maximum. Represented as a float, e.g. '200.00'.
The UUID of the garnishment to update.
The maximum deduction per pay period. A null value indicates no maximum. Represented as a float, e.g. '16.00'.
Whether the amount should be treated as a percentage to be deducted per pay period. Default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_HISTORICAL_EMPLOYEETool to update a historical employee in Gusto. Historical employees are employees that were previously dismissed from the company in the current year. Use when you need to update information for a terminated employee.
Input parameters
Social Security Number of the historical employee (9 digits, no dashes).
The personal email address of the historical employee.
The current version of the object. Required for optimistic locking to prevent concurrent update conflicts.
Last name of the historical employee.
The UUID of the company.
First name of the historical employee.
Date of birth of the historical employee in YYYY-MM-DD format.
Middle initial of the historical employee.
Preferred first name of the historical employee.
The UUID of the historical employee to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_HOLIDAY_PAY_POLICYTool to update a company's holiday pay policy in Gusto. Use when you need to configure which federal holidays are included in the company's holiday pay policy.
Input parameters
The current version of the object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
The UUID of the company whose holiday pay policy is being updated.
Configuration for the eleven supported federal holidays. Specify which holidays should be included in the company's holiday pay policy.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_HOME_ADDRESSTool to update an employee's home address in Gusto. Use when you need to change an employee's residential address details.
Input parameters
The ZIP code of the address
The city of the address
The state of the address (two-letter abbreviation)
The current version of the object. Required for optimistic locking. See the versioning guide for information on how to use this field.
The first line of the street address
The second line of the street address (e.g., apartment, suite)
The date the employee started living at the address in YYYY-MM-DD format
The UUID of the home address to update
Determines if home taxes should be withheld and paid for employee
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_INDUSTRY_SELECTIONTool to update the industry classification for a company by providing a NAICS code. Use when you need to set or change a company's industry classification in Gusto's payroll system.
Input parameters
Industry title describing the company's business classification
List of Standard Industrial Classification (SIC) four-digit codes that categorize the company's business activities. If not provided, Gusto will perform an internal lookup using the naics_code
The UUID of the company whose industry classification to update
North American Industry Classification System (NAICS) six-digit code that classifies the business based on its primary type of work
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_JOBSTool to update a job in Gusto. Use when you need to modify job details such as title, hire date, workers' compensation settings, or shareholder status. Requires the current version for optimistic locking.
Input parameters
The job title
The UUID of the job to update
The current version of the job object. See the versioning guide for information on how to use this field. This is required for optimistic locking to prevent concurrent updates.
The date when the employee was hired or rehired for the job in YYYY-MM-DD format
Whether this job is eligible for workers' compensation coverage in the state of Washington (WA)
The risk class code for workers' compensation in Washington state. Please visit Washington state's Risk Class page to learn more.
Whether the employee owns at least 2% of the company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_LOCATIONTool to update an existing location in Gusto. Use when you need to modify address details, phone number, or filing/mailing address status for a location. Requires the current version for optimistic locking.
Input parameters
ZIP code. Must be a valid US zip (e.g. 12345 or 12345-6789).
City name
State code (e.g. CA). Must be a valid two-letter state code.
Country code. Defaults to USA.
The current version of the location object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
Street address line 1
Street address line 2 (optional)
The UUID of the location to update
Phone number for the location. Must be exactly 10 digits (no spaces, dashes, or parentheses).
Specify if this location is the company's filing address
Specify if this location is the company's mailing address
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_ONBOARDING_DOCUMENTS_CONFIGTool to update an employee's onboarding documents configuration in Gusto. Use when you need to indicate whether to include Form I-9 during employee onboarding.
Input parameters
The UUID of the employee
Whether to include Form I-9 for this employee during onboarding. When true, the employee will be prompted to complete Form I-9 as part of their onboarding.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_PAY_SCHEDULETool to update a pay schedule in Gusto. Use when you need to modify pay schedule settings such as custom name, anchor dates, frequency, or auto-payroll configuration.
Input parameters
An integer between 1 and 31 indicating the first day of the month that employees are paid. This field is only relevant for pay schedules with the 'Twice per month' and 'Monthly' frequencies. It will be null for pay schedules with other frequencies.
An integer between 1 and 31 indicating the second day of the month that employees are paid. This field is the second pay date for pay schedules with the 'Twice per month' frequency. For semi-monthly pay schedules, set this field to 31. For months shorter than 31 days, the second pay date will be set to the last day of the month. It will be null for pay schedules with other frequencies.
The current version of the pay schedule object. Required for optimistic locking to prevent concurrent modifications. See the versioning guide for details.
The frequency that employees on this pay schedule are paid with Gusto.
The UUID of the company.
A custom name for the pay schedule.
With automatic payroll enabled, payroll will run automatically one day before your payroll deadlines.
The first date that employees on this pay schedule are paid with Gusto in YYYY-MM-DD format.
The UUID of the pay schedule to update.
The last date of the first pay period in YYYY-MM-DD format. This can be the same date as the anchor pay date.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_RECURRING_REIMBURSEMENTTool to update an existing recurring reimbursement in Gusto. Use when you need to modify the amount or description of a recurring reimbursement. Requires the current version for optimistic locking.
Input parameters
The UUID of the recurring reimbursement to update
The amount of the recurring reimbursement. Must be a positive number (e.g., 85.00).
The current version of the recurring reimbursement object. Required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field.
Description of the recurring reimbursement. Use this field to provide details about what the reimbursement is for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_SALARY_ESTIMATETool to update a salary estimate for an S-Corp owner in Gusto. Use when you need to modify occupation details, location, or business revenue for salary calculations. Cannot update if the estimate has already been finalized.
Input parameters
The UUID of the salary estimate to update
The ZIP code for location-based salary calculations (5 digits)
Array of occupations with experience levels and time allocations. Time percentages must sum to 100% (1.0)
The annual net revenue of the business in dollars (must be greater than 0 if provided)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_SECTION603_HIGH_EARNER_STATUSTool to update an employee's Section 603 high earner status for a specific year. Use when you need to set or modify whether an employee is classified as a high earner under Section 603 of the SECURE 2.0 Act, which affects their retirement contribution tax treatment.
Input parameters
The UUID of the employee whose Section 603 high earner status is being updated.
The effective year for the Section 603 high earner status. Must be a valid year (e.g., 2026).
Whether the employee is classified as a high earner for Section 603 purposes. Section 603 of the SECURE 2.0 Act requires employees aged 50 or older whose prior-year FICA wages exceed the IRS threshold to have their catch-up contributions to pre-tax retirement benefits designated as post-tax contributions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_STATE_TAXESTool to update state tax attributes for an employee in Gusto. Use when you need to update state-specific tax information such as withholding exemptions or additional withholding amounts. Answers must be supplied in effective-dated format with valid_from='2010-01-01' and valid_up_to=null.
Input parameters
List of states with their tax information to update. Each state contains answers to tax questions.
The UUID of the employee whose state taxes are being updated.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_STATE_TAX_REQUIREMENTSTool to update state tax requirements for a company in Gusto. Use when you need to update state-specific tax settings such as tax rates, unemployment insurance rates, or other state tax compliance requirements.
Input parameters
2-letter US state abbreviation for the state tax requirements to update.
The UUID of the company whose state tax requirements are being updated.
List of requirement sets to update. Each set contains tax requirements for a specific category (e.g., tax rates, unemployment insurance).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_TIME_OFF_POLICIES_BALANCETool to update time off hours balances for employees under a time off policy. Use when you need to set or adjust employee vacation or sick leave balances for a specific policy. Requires the time_off_policies:write scope.
Input parameters
List of employees with their new balance values. Each entry specifies an employee UUID and their new balance in hours.
The UUID of the time off policy to update balances for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_TIME_OFF_POLICYTool to update a time off policy in Gusto. Use when you need to modify vacation or sick leave policy settings such as accrual rates, limits, carryover rules, or termination payout configuration. Requires the policy version for optimistic locking.
Input parameters
Name of the time off policy. Update this to change the policy name (e.g., 'Updated Vacation Policy', 'Sick Leave').
The current version of the time off policy object. This field is required for optimistic locking to prevent concurrent updates. See the versioning guide for information on how to use this field. Get the current version by first retrieving the policy details.
Boolean representing if a policy has completed configuration. Set to true when the policy setup is complete and ready to be activated.
The max number of hours an employee can accrue total. Represented as a float string (e.g., '160.0', '240.0').
Time off policy type.
The rate at which the time off hours will accrue for an employee on the policy. Represented as a float string (e.g., '0.05', '40.0'). Required for hourly accrual methods.
Policy time off accrual method.
The number of hours an employee has to work or be paid for to accrue the number of hours set in the accrual rate. Only used for hourly policies (per_hour_paid, per_hour_paid_no_overtime, per_hour_work, per_hour_worked_no_overtime). Represented as a float string (e.g., '1.0', '40.0').
The date the policy resets. Format MM-DD (e.g., '01-01' for January 1st, '07-01' for July 1st).
The UUID of the time off policy to update. This is the unique identifier for the time off policy in Gusto (e.g., '45635f6a-e78b-4641-86b4-d7bce9b20cb2').
The max number of hours an employee can carryover from one year to the next. Represented as a float string (e.g., '40.0', '80.0').
Boolean representing if an employee's accrued time off hours will be paid out on termination. Set to true if unused hours should be paid when an employee leaves.
The max number of hours an employee can accrue in a year. Represented as a float string (e.g., '120.0', '200.0').
Number of days before an employee on the policy will begin accruing time off hours. If not specified, employees start accruing immediately.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_TIME_TRACKING_TIME_SHEETTool to update a time tracking time sheet in Gusto. Use when you need to modify shift times, time zone, or hours worked with their pay classifications for an employee's time sheet.
Input parameters
List of hours entries categorized by pay classification (regular, overtime, double_overtime)
The current version of the time sheet for optimistic locking to prevent conflicts
The IANA time zone identifier for the shift (e.g., America/Los_Angeles, America/New_York)
The ISO 8601 timestamp when the shift ended (e.g., 2026-03-05T18:00:00)
The UUID of the time sheet to update
The ISO 8601 timestamp when the shift started (e.g., 2026-03-05T09:00:00)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
GUSTO_UPDATE_WORK_ADDRESSTool to update an employee work address in Gusto. Use when you need to change an employee's work location or effective date. Requires the version field for optimistic locking.
Input parameters
The current version of the work address object. Required for optimistic locking to prevent concurrent modifications. See the versioning guide for information on how to use this field.
UUID reference to the company location for this work address
The date the employee began working at this location in YYYY-MM-DD format
The UUID of the work address to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 62 agents privately built on Nagent that already use Gusto.
Build on Nagent
Connect Gusto to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Gusto, and click "Connect Now." You'll authenticate with OAuth — Nagent handles credential storage and refresh automatically. Once connected, Gusto is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Gusto is connected, you configure its 192 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Gusto steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Gusto event fires, the agent kicks off automatically.
Every Gusto action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Gusto ships with 192 pre-built human resources actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Gusto together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Gusto-based workflows tailored to your business.