Team
Shared credential for production and unattended runs.
Connect Gusto with Hookshot™ and your stack
Modern payroll, benefits, and HR management platform for small and medium businesses
Tools and triggers
What Agents can do in Gusto
Available tools and events after Gusto is connected.
-
Add Employees to Holiday Pay Policy
Tool 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.
-
Add Employees to Time Off Policy
Tool 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…
-
Add People to Department
Tool to add employees and contractors to a department in Gusto. Use when you need to assign people to a specific department for organizational structure.
-
Assign Pay Schedules
Tool 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…
-
Calculate Accruing Time Off Hours
Tool 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…
-
Create Admin
Tool 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…
-
Create Company Bank Account
Tool to create a company bank account in Gusto. Use when you need to add a new bank account for payroll processing.
-
Create Company Benefit
Tool 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.
-
Create Company Location
Tool to create a company location in Gusto. Use when you need to add a new address for a company (mailing, filing, or work location).
-
Create Company Signatory
Tool 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.
-
Create Contractor
Tool 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…
-
Create Contractor Bank Account
Tool 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…
-
Create Custom Report
Tool 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…
-
Create Department
Tool to create a new department in a Gusto company. Use when you need to add a new department for organizational structure.
-
Create Earning Type
Tool 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.
-
Create Employee
Tool to create a new employee in Gusto. Use when you need to add a new employee to a company's payroll system.
-
Create Employee Bank Account
Tool 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.
-
Create Employee Benefit
Tool 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.
-
Create Employee Rehire
Tool 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…
-
Create Employee Work Address
Tool 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.
-
Create Employee YTD Benefit Amounts
Tool 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.
-
Create Employees Annual FICA Wage Report
Tool 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…
-
Create Flows
Tool 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…
-
Create Garnishment
Tool 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.
-
Create Historical Employee
Tool 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…
-
Create Holiday Pay Policy
Tool 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.
-
Create Job
Tool 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.
-
Create Job Compensation
Tool 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.
-
Create Pay Schedule Assignment Preview
Tool 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.
-
Create Payroll General Ledger Report
Tool 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…
-
Create Section 603 High Earner Status
Tool 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.
-
Create Time Off Policy
Tool 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…
-
Create Time Sheet
Tool 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.
-
Deactivate Earning Type
Tool 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.
-
Deactivate Time Off Policy
Tool 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.
-
Delete Company Bank Account
Tool 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.
-
Delete Company Holiday Pay Policy
Tool to delete a company's holiday pay policy in Gusto. Use when you need to remove the holiday pay policy for a company.
-
Delete Compensation
Tool to delete a compensation by its UUID. Use when you need to remove a compensation record from Gusto.
-
Delete Contractor
Tool to delete a contractor from Gusto. Use when you need to permanently remove a contractor from the system.
-
Delete Department
Tool 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.
-
Delete Employee
Tool to delete an onboarding employee from Gusto. Use when you need to remove an employee who has not yet been onboarded.
-
Delete Employee Bank Account
Tool to delete an employee bank account in Gusto. Use when you need to remove a bank account from an employee's profile.
-
Delete Employee Benefit
Tool to delete an employee benefit by its UUID. Use when you need to remove an employee's enrollment in a specific benefit from Gusto.
-
Delete Employee Home Address
Tool to delete an employee's home address in Gusto. Use when you need to remove a home address from an employee's profile.
-
Delete Employee Termination
Tool to delete an employee termination in Gusto. Use when you need to remove a pending termination for an employee.
-
Delete I-9 Authorization Document
Tool 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.
-
Delete Job
Tool to delete an individual job from Gusto. Use when you need to remove a job by its UUID.
-
Delete Time Tracking Time Sheet
Tool to delete a time sheet from Gusto time tracking. Use when you need to permanently remove a time sheet from the system.
-
Delete Work Address
Tool to delete an employee's work address from Gusto. Use when you need to remove a work address by its UUID.
-
Download Company Forms PDF
Tool 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.
-
Download Employee Forms PDF
Tool 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.
-
Finish Company Onboarding
Tool to finish company onboarding in Gusto. Use when you need to mark a company's onboarding process as complete.
-
Get Benefit
Tool to retrieve a benefit supported by Gusto. Returns high-level information about a particular benefit type and its tax considerations.
-
Get Company
Tool 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.
-
Get Company Attachment Download URL
Tool to retrieve a temporary URL to download a company attachment file. Use when you need to access uploaded company documents or files.
-
Get Company Benefit
Tool 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.
-
Get Company Benefit Summary
Tool 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…
-
Get Company Departments
Tool 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.
-
Get Company Earning Types
Tool 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.
-
Get Company Form
Tool 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.
-
Get Company Holiday Pay Policy
Tool 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.
-
Get Company Locations
Tool to get all company locations. Use when you need to retrieve address information for all locations associated with a specific company.
-
Get Company Onboarding Status
Tool 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.
-
Get Company Report Template
Tool to get a report template for a company. Use when you need to retrieve the recommended columns and groupings for a specific report type.
-
Get Company Suspensions
Tool 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.
-
Get Compensation
Tool 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.
-
Get Contractor
Tool 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.
-
Get Contractor Address
Tool 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.
-
Get Contractor Bank Accounts
Tool 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.
-
Get Contractor Document
Tool 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.
-
Get Contractor Document PDF
Tool 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.
-
Get Contractor Payment Groups
Tool 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…
-
Get Contractor Payments
Tool 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.
-
Get Department
Tool 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.
-
Get Employee
Tool 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.
-
Get Employee All Benefits
Tool 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.
-
Get Employee Bank Accounts
Tool 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.
-
Get Employee Benefit
Tool 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…
-
Get Employee Federal Taxes
Tool 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…
-
Get Employee Form
Tool 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.
-
Get Employee Jobs
Tool 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.
-
Get Employee Pay Stub
Tool 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.
-
Get Employee Payment Method
Tool 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.
-
Get Employee Recurring Reimbursements
Tool to get all recurring reimbursements for an employee. Use when you need to retrieve recurring reimbursement information for a specific employee.
-
Get Employee State Taxes
Tool 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.
-
Get Federal Tax Details
Tool 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…
-
Get Garnishment
Tool 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…
-
Get Home Address
Tool 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.
-
Get Job
Tool 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.
-
Get Location
Tool to retrieve a specific location by UUID. Use when you need to get detailed address information for a single location.
-
Get Notification
Tool 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.
-
Get Pay Schedule
Tool to retrieve a specific pay schedule by its UUID. Use when you need detailed information about a particular pay schedule for a company.
-
Get Payroll
Tool 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.
-
Get Payroll Receipt
Tool 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.
-
Get People Batches
Tool 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.
-
Get Recurring Reimbursement
Tool to get a recurring reimbursement by its UUID. Use when you need to retrieve details of a specific recurring reimbursement.
-
Get Report
Tool 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…
-
Get Salary Estimate
Tool 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.
-
Get State Tax Requirements
Tool 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…
-
Get Tax Liabilities
Tool 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.
-
Get Time Off Policy
Tool 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.
-
Get Time Tracking Time Sheet
Tool 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…
-
Get Token Info
Tool 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.
-
Get Work Address
Tool 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.
-
Invite Signatory
Tool 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.
-
List ACH Transactions
Tool 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.
-
List Benefits
Tool 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.
-
List Benefits Requirements
Tool 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.
-
List Child Support Agencies
Tool 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…
-
List Companies Time Off Requests
Tool 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.
-
List Company Attachments
Tool 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.
-
List Company Bank Accounts
Tool 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.
-
List Company Benefits
Tool 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…
-
List Company Benefits Contribution Exclusions
Tool 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…
-
List Company Benefits Employee Benefits
Tool 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…
-
List Company Custom Fields
Tool to retrieve the custom fields configured for a company. Use when you need to know the schema of custom fields at the company level.
-
List Company Forms
Tool 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.
-
List Contractor Documents
Tool 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.
-
List Contractor Forms
Tool 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.
-
List Contractor Onboarding Status
Tool 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.
-
List Contractor Payment Details
Tool 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…
-
List Contractor Payment Method
Tool 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.
-
List Contractors
Tool 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…
-
List Employee Custom Fields
Tool to retrieve the custom fields configured for an employee. Use when you need to get the custom field values for a specific employee.
-
List Employee Forms
Tool 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.
-
List Employee Home Addresses
Tool 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…
-
List Employee Onboarding Status
Tool 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.
-
List Employee Payment Details
Tool 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…
-
List Employee Work Addresses
Tool 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.
-
List Employees
Tool 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.
-
List Employment History
Tool 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.
-
List Information Requests
Tool 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.
-
List Job Compensations
Tool 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…
-
List Migration Readiness
Tool 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.
-
List Minimum Wages
Tool 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.
-
List Notifications
Tool 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…
-
List Paid Holidays
Tool 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.
-
List Pay Periods
Tool 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…
-
List Pay Schedules
Tool 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.
-
List Pay Schedules Assignments
Tool 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…
-
List Pay Schedules Preview
Tool 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…
-
List Pay Stubs
Tool 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.
-
List Payroll Blockers
Tool 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…
-
List Payroll Reversals
Tool to retrieve all approved payroll reversals for a company. Use when you need to view reversals that have been applied to previous payroll runs.
-
List Recovery Cases
Tool 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…
-
List Signatories
Tool 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.
-
List Tax Requirements
Tool 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.
-
List Time Off Activities
Tool 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.
-
List Time Off Policies
Tool 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.
-
List Time Tracking Time Sheets
Tool 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…
-
List Unprocessed Termination Pay Periods
Tool to retrieve unprocessed termination pay periods for a company. Use when you need to view dismissal payrolls for past and future terminated employees.
-
List Wire in Requests
Tool 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.
-
List YTD Benefit Amounts From Different Company
Tool 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…
-
Remove Employees From Holiday Pay Policy
Tool 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.
-
Remove Employees From Time Off Policy
Tool 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.
-
Remove People From Department
Tool to remove employees and contractors from a department in Gusto. Use when you need to unassign people from a department.
-
Retrieve Terms of Service Status
Tool 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.
-
Update Company
Tool 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.
-
Update Company Benefit
Tool 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…
-
Update Company Benefit Contribution Exclusions
Tool 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…
-
Update Company Industry Selection
Tool 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.
-
Update Contractor Address
Tool 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…
-
Update Contractor Payment Method
Tool 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…
-
Update Department
Tool to update a department in Gusto. Use when you need to modify department details like the title. Requires the current version for optimistic locking.
-
Update Earning Type
Tool to update an earning type in Gusto. Use when you need to modify the name of a custom earning type for a company.
-
Update Employee
Tool 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.
-
Update Employee Bank Account
Tool to update an employee bank account in Gusto. Use when you need to modify existing employee bank account details.
-
Update Employee Benefit
Tool 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…
-
Update Employee Benefits
Tool 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.
-
Update Employee Federal Taxes
Tool 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…
-
Update Employee Onboarding Status
Tool 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.
-
Update Employee Payment Method
Tool 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…
-
Update Employee Rehire
Tool to update an employee rehire in Gusto. Use when you need to modify the details of a pending rehire for a terminated employee.
-
Update Employee Termination
Tool 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.
-
Update Federal Tax Details
Tool 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.
-
Update Garnishment
Tool 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…
-
Update Historical Employee
Tool 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.
-
Update Holiday Pay Policy
Tool 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.
-
Update Home Address
Tool to update an employee's home address in Gusto. Use when you need to change an employee's residential address details.
-
Update Jobs
Tool 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.
-
Update Location
Tool 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.
-
Update Onboarding Documents Config
Tool 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.
-
Update Pay Schedule
Tool 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.
-
Update Recurring Reimbursement
Tool 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.
-
Update Salary Estimate
Tool 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…
-
Update Section 603 High Earner Status
Tool 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…
-
Update State Tax Requirements
Tool 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.
-
Update State Taxes
Tool 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…
-
Update Time Off Policy
Tool 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…
-
Update Time Off Policy Balance
Tool 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.
-
Update Time Tracking Time Sheet
Tool 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.
-
Update Work Address
Tool 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.
Setup
Connect Gusto in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
