> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gusto

> How to set up the Gusto connector, plus the actions and events that are available.

![Gusto](https://stackone-logos.com/api/gusto/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/gusto/changelog.md)

[96 actions](#actions) · [24 events](#events) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/gusto/guides/connector-profile/oauth-2-0.md)
>
> Actions run with the access of the Gusto admin who authorizes the connection. Production credentials need pre-approval f...

Optionally, configure receiving Events for Gusto into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/gusto/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/gusto/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

companies:read

companies:write

company\_attachments:read

company\_attachments:write

company\_bank\_accounts:read

company\_bank\_accounts:write

company\_benefits:read

company\_benefits:write

compensations:read

compensations:write

contractors:manage

contractors:read

contractors:write

departments:read

departments:write

employee\_benefits:read

employee\_benefits:write

employees:manage

employees:read

employees:write

jobs:read

jobs:write

payrolls:read

payrolls:run

payrolls:write

time\_off\_policies:read

time\_off\_policies:write

No scopes found

96 actions

ActionDescriptionRequired scopes

List Company Bank Accounts`gusto_list_company_bank_accounts`

Get all bank accounts for a company

`company_bank_accounts:read`

Create Company Bank Account`gusto_create_company_bank_account`

Create a new company bank account

`company_bank_accounts:write`

Verify Company Bank Account`gusto_verify_company_bank_account`

Verify a company bank account using micro-deposits

`company_bank_accounts:write`

Delete Company Bank Account`gusto_delete_company_bank_account`

Disable a company bank account

`company_bank_accounts:write`

List Company Benefits`gusto_list_company_benefits`

Get all benefits for a company

`company_benefits:read`

Get Company Benefit`gusto_get_company_benefit`

Get details of a specific company benefit

`company_benefits:read`

Update Company Benefit`gusto_update_company_benefit`

Update an existing company benefit

`company_benefits:write`

List Employee Benefits`gusto_list_employee_benefits`

Get all benefits for an employee

`employee_benefits:read`

Get Employee Benefit`gusto_get_employee_benefit`

Get details of a specific employee benefit enrollment

`employee_benefits:read`

Create Employee Benefit`gusto_create_employee_benefit`

Enroll an employee in a company benefit

`employee_benefits:write`

Update Employee Benefit`gusto_update_employee_benefit`

Update an employee's benefit enrollment

`employee_benefits:write`

Delete Employee Benefit`gusto_delete_employee_benefit`

Remove an employee from a benefit enrollment

`employee_benefits:write`

Get Company`gusto_get_company`

Get details of a specific company

`companies:read`

List Company Attachments`gusto_list_company_attachments`

List all attachments for a company

`company_attachments:read`

Get Company Attachment`gusto_get_company_attachment`

Get a specific company attachment by UUID

`company_attachments:read`

Upload Company Attachment`gusto_upload_company_attachment`

Upload a file as a company attachment

`company_attachments:write`

Get Company Attachment Download URL`gusto_get_company_attachment_download_url`

Get a temporary download URL for a company attachment

`company_attachments:read`

List Job Compensations`gusto_list_job_compensations`

Get all compensations for a job

`compensations:read`

Get Compensation`gusto_get_compensation`

Get details of a specific compensation

`compensations:read`

Create Compensation`gusto_create_compensation`

Create a new compensation for a job

`compensations:write`

Update Compensation`gusto_update_compensation`

Update an existing compensation

`compensations:write`

Delete Compensation`gusto_delete_compensation`

Delete a compensation

`compensations:write`

List Contractors`gusto_list_contractors`

Get all contractors for a company

`contractors:read`

Get Contractor`gusto_get_contractor`

Get details of a specific contractor

`contractors:read`

Create Contractor`gusto_create_contractor`

Create a new contractor for the company

`contractors:manage`

Update Contractor`gusto_update_contractor`

Update a contractor's information

`contractors:write`

Delete Contractor`gusto_delete_contractor`

Delete a contractor

`contractors:manage`

List Departments`gusto_list_departments`

Get all departments for a company

`departments:read`

Get Department`gusto_get_department`

Get details of a specific department

`departments:read`

Create Department`gusto_create_department`

Create a new department for the company

`departments:write`

Update Department`gusto_update_department`

Update an existing department

`departments:write`

Delete Department`gusto_delete_department`

Delete a department

`departments:write`

List Employees`gusto_list_employees`

Get all employees for a company

`employees:read`

Get Employee`gusto_get_employee`

Get details of a specific employee

`employees:read`

Create Employee`gusto_create_employee`

Create a new employee

`employees:manage`

Update Employee`gusto_update_employee`

Update an employee

`employees:write`

List Employee Home Addresses`gusto_list_employee_home_addresses`

Get all home addresses for an employee

`employees:read`

Get Home Address`gusto_get_home_address`

Get a specific home address

`employees:read`

Create Employee Home Address`gusto_create_employee_home_address`

Create a home address for an employee

`employees:write`

Update Home Address`gusto_update_home_address`

Update an employee's home address

`employees:write`

Delete Home Address`gusto_delete_home_address`

Delete an employee's home address

`employees:write`

List Employee Work Addresses`gusto_list_employee_work_addresses`

Get all work addresses for an employee

`employees:read`

Get Work Address`gusto_get_work_address`

Get a specific work address

`employees:read`

Create Employee Work Address`gusto_create_employee_work_address`

Create a work address for an employee

`employees:manage`

Update Work Address`gusto_update_work_address`

Update an employee's work address

`employees:manage`

Delete Work Address`gusto_delete_work_address`

Delete an employee's work address

`employees:manage`

Get Employee Custom Fields`gusto_get_employee_custom_fields`

Get custom field values for an employee

`employees:read`

Get Employee Employment History`gusto_get_employee_employment_history`

Get employment history for an employee

`employees:read`

Terminate Employee`gusto_terminate_employee`

Terminate an employee

`employees:manage`

Webhook Subscription Verify`gusto_webhook_verify`

Handles Gusto's async subscription verification — obtains a system access token and confirms the verification\_token so t...

Webhook Verification`gusto_webhook_verification`

Acknowledges any unmatched payload with a 200 and no emitted event, so the webhook stays healthy.

Bank Account Webhook`gusto_webhook_bank_account`

Processes Gusto BankAccount webhook events for company, employee, and contractor bank accounts (e.g. company.bank\_accoun...

Company Webhook`gusto_webhook_company`

Processes Gusto Company webhook events (e.g. company.provisioned).

Company Benefit Webhook`gusto_webhook_company_benefit`

Processes Gusto CompanyBenefit webhook events (e.g. company\_benefit.created).

Contractor Webhook`gusto_webhook_contractor`

Processes Gusto Contractor webhook events (e.g. contractor.created).

Contractor Payment Webhook`gusto_webhook_contractor_payment`

Processes Gusto ContractorPayment webhook events (e.g. contractor\_payment.created).

Contractor Payment Group Webhook`gusto_webhook_contractor_payment_group`

Processes Gusto ContractorPaymentGroup webhook events (e.g. contractor\_payment\_group.created).

Document Webhook`gusto_webhook_document`

Processes Gusto Document webhook events (e.g. contractor.document.created).

Employee Webhook`gusto_webhook_employee`

Processes Gusto Employee webhook events (e.g. employee.created).

Home Address Webhook`gusto_webhook_home_address`

Processes Gusto HomeAddress webhook events (e.g. employee.home\_address.created).

Work Address Webhook`gusto_webhook_work_address`

Processes Gusto WorkAddress webhook events (e.g. employee.work\_address.created).

Employee Benefit Webhook`gusto_webhook_employee_benefit`

Processes Gusto EmployeeBenefit webhook events (e.g. employee\_benefit.created).

Employee Job Compensation Webhook`gusto_webhook_employee_job_compensation`

Processes Gusto EmployeeJobCompensation webhook events (e.g. employee\_job\_compensation.created).

External Payroll Webhook`gusto_webhook_external_payroll`

Processes Gusto ExternalPayroll webhook events (e.g. external\_payroll.created).

Fast Ach Config Webhook`gusto_webhook_fast_ach_config`

Processes Gusto FastAchConfig webhook events (e.g. fast\_ach\_config.activated).

Form Webhook`gusto_webhook_form`

Processes Gusto Form webhook events (e.g. form.created).

Generated Document Webhook`gusto_webhook_generated_document`

Processes Gusto GeneratedDocument webhook events (e.g. generated\_document.generated).

Location Webhook`gusto_webhook_location`

Processes Gusto Location webhook events (e.g. location.created).

Notification Webhook`gusto_webhook_notifications`

Processes Gusto Notification webhook events (e.g. notification.information\_request.created).

Payroll Webhook`gusto_webhook_payroll`

Processes Gusto Payroll webhook events (e.g. payroll.created).

Pay Schedule Webhook`gusto_webhook_pay_schedule`

Processes Gusto PaySchedule webhook events (e.g. pay\_schedule.created).

Signatory Webhook`gusto_webhook_signatory`

Processes Gusto Signatory webhook events (e.g. signatory.created).

Time Off Request Webhook`gusto_webhook_time_off_request`

Processes Gusto TimeOffRequest webhook events (e.g. time\_off\_request.created).

List Employee Jobs`gusto_list_employee_jobs`

Get all jobs for an employee

`jobs:read`

Get Job`gusto_get_job`

Get details of a specific job

`jobs:read`

Create Job`gusto_create_job`

Create a new job for an employee

`jobs:write`

Update Job`gusto_update_job`

Update an existing job

`jobs:write`

Delete Job`gusto_delete_job`

Delete a job

`jobs:write`

List Company Locations`gusto_list_company_locations`

Get all locations for a company

`companies:read`

Get Location`gusto_get_location`

Get details of a specific location

`companies:read`

Create Company Location`gusto_create_company_location`

Create a new company location

`companies:write`

Update Location`gusto_update_location`

Update an existing location

`companies:write`

List Company Payrolls`gusto_list_company_payrolls`

Get all payrolls for a company

`payrolls:read`

Get Payroll`gusto_get_payroll`

Get details of a specific payroll

`payrolls:read`

Create Off-Cycle Payroll`gusto_create_off_cycle_payroll`

Create a new off-cycle payroll

`payrolls:run`

Delete Payroll`gusto_delete_payroll`

Delete an unprocessed payroll

`payrolls:run`

List Pay Schedules`gusto_list_pay_schedules`

Get all pay schedules for a company

`payrolls:read`

Get Pay Schedule`gusto_get_pay_schedule`

Get details of a specific pay schedule

`payrolls:read`

Create Pay Schedule`gusto_create_pay_schedule`

Create a new pay schedule for the company

`payrolls:write`

Update Pay Schedule`gusto_update_pay_schedule`

Update an existing pay schedule

`payrolls:write`

List Time Off Policies`gusto_list_time_off_policies`

Get all time off policies for a company

`time_off_policies:read`

Get Time Off Policy`gusto_get_time_off_policy`

Get details of a specific time off policy

`time_off_policies:read`

Create Time Off Policy`gusto_create_time_off_policy`

Create a new time off policy for the company

`time_off_policies:write`

Update Time Off Policy`gusto_update_time_off_policy`

Update an existing time off policy

`time_off_policies:write`

Add Employees To Time Off Policy`gusto_add_employees_to_time_off_policy`

Add employees to a time off policy

`time_off_policies:write`

Update Employee Time Off Balances`gusto_update_time_off_balances`

Update time off balances for employees on a policy

`time_off_policies:write`

## Events

Tags

Select all
|
Clear

Bank Accounts

Benefits

Companies

Compensations

Contractors

Documents

Employees

External Payrolls

Fast ACH Configurations

Forms

Generated Documents

Home Addresses

Jobs

Locations

Notifications

Pay Schedules

Payments

Payrolls

Signatories

Time Off Requests

Webhooks

Work Addresses

No tags found

24 events

EventDescriptionTags

Webhook Subscription Verify`gusto_webhook_verify`

Handles Gusto's async subscription verification — obtains a system access token and confirms the verification\_token so t...

Webhooks

Webhook Verification`gusto_webhook_verification`

Acknowledges any unmatched payload with a 200 and no emitted event, so the webhook stays healthy.

Webhooks

Bank Account Webhook`gusto_webhook_bank_account`

Processes Gusto BankAccount webhook events for company, employee, and contractor bank accounts (e.g. company.bank\_accoun...

Bank AccountsWebhooks

Company Webhook`gusto_webhook_company`

Processes Gusto Company webhook events (e.g. company.provisioned).

CompaniesWebhooks

Company Benefit Webhook`gusto_webhook_company_benefit`

Processes Gusto CompanyBenefit webhook events (e.g. company\_benefit.created).

BenefitsWebhooks

Contractor Webhook`gusto_webhook_contractor`

Processes Gusto Contractor webhook events (e.g. contractor.created).

ContractorsWebhooks

Contractor Payment Webhook`gusto_webhook_contractor_payment`

Processes Gusto ContractorPayment webhook events (e.g. contractor\_payment.created).

ContractorsPaymentsWebhooks

Contractor Payment Group Webhook`gusto_webhook_contractor_payment_group`

Processes Gusto ContractorPaymentGroup webhook events (e.g. contractor\_payment\_group.created).

ContractorsPaymentsWebhooks

Document Webhook`gusto_webhook_document`

Processes Gusto Document webhook events (e.g. contractor.document.created).

DocumentsWebhooks

Employee Webhook`gusto_webhook_employee`

Processes Gusto Employee webhook events (e.g. employee.created).

EmployeesWebhooks

Home Address Webhook`gusto_webhook_home_address`

Processes Gusto HomeAddress webhook events (e.g. employee.home\_address.created).

EmployeesHome AddressesWebhooks

Work Address Webhook`gusto_webhook_work_address`

Processes Gusto WorkAddress webhook events (e.g. employee.work\_address.created).

EmployeesWork AddressesWebhooks

Employee Benefit Webhook`gusto_webhook_employee_benefit`

Processes Gusto EmployeeBenefit webhook events (e.g. employee\_benefit.created).

EmployeesBenefitsWebhooks

Employee Job Compensation Webhook`gusto_webhook_employee_job_compensation`

Processes Gusto EmployeeJobCompensation webhook events (e.g. employee\_job\_compensation.created).

JobsCompensationsWebhooks

External Payroll Webhook`gusto_webhook_external_payroll`

Processes Gusto ExternalPayroll webhook events (e.g. external\_payroll.created).

External PayrollsWebhooks

Fast Ach Config Webhook`gusto_webhook_fast_ach_config`

Processes Gusto FastAchConfig webhook events (e.g. fast\_ach\_config.activated).

Fast ACH ConfigurationsWebhooks

Form Webhook`gusto_webhook_form`

Processes Gusto Form webhook events (e.g. form.created).

FormsWebhooks

Generated Document Webhook`gusto_webhook_generated_document`

Processes Gusto GeneratedDocument webhook events (e.g. generated\_document.generated).

Generated DocumentsWebhooks

Location Webhook`gusto_webhook_location`

Processes Gusto Location webhook events (e.g. location.created).

LocationsWebhooks

Notification Webhook`gusto_webhook_notifications`

Processes Gusto Notification webhook events (e.g. notification.information\_request.created).

NotificationsWebhooks

Payroll Webhook`gusto_webhook_payroll`

Processes Gusto Payroll webhook events (e.g. payroll.created).

PayrollsWebhooks

Pay Schedule Webhook`gusto_webhook_pay_schedule`

Processes Gusto PaySchedule webhook events (e.g. pay\_schedule.created).

Pay SchedulesWebhooks

Signatory Webhook`gusto_webhook_signatory`

Processes Gusto Signatory webhook events (e.g. signatory.created).

SignatoriesWebhooks

Time Off Request Webhook`gusto_webhook_time_off_request`

Processes Gusto TimeOffRequest webhook events (e.g. time\_off\_request.created).

Time Off RequestsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.