> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/gusto.md).

# Gusto

Gusto is a payroll, benefits, and HR platform for small businesses. List and manage employees, read and run payrolls, and fetch time-off requests from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Gusto     | OAuth sign-in  |

#### Gusto

Connect to Gusto to manage employees, payrolls, and time off for a company.

**Set up in Gusto**

1. Use a Gusto account with access to the records and operations that your workflow needs.
2. If your organization restricts application access or user consent, have its administrator approve the connection before you sign in.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Gusto**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Gusto** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Employees

List the employees of the connected Gusto company.

**Required permissions:** `employees:read`.

**Inputs**

| Field       | Type    | Required | Description                                         |
| ----------- | ------- | -------- | --------------------------------------------------- |
| Search Term | string  | No       | Filter employees by name or title.                  |
| Terminated  | boolean | No       | Filter by termination status (leave empty for all). |
| Onboarded   | boolean | No       | Filter by onboarding status (leave empty for all).  |
| Limit       | integer | No       | Maximum employees to return (default 25).           |

**Outputs**

| Field       | Type        | Description                                           |
| ----------- | ----------- | ----------------------------------------------------- |
| Employees   | dict\_array | The company's employees.                              |
| Total Count | integer     | Total matching employees, as reported by Gusto.       |
| Has More    | boolean     | True if more employees exist beyond the returned set. |

#### Create Employee

Create an employee in the connected Gusto company.

**Required permissions:** `employees:manage`.

**Inputs**

| Field                | Type    | Required | Description                                                  |
| -------------------- | ------- | -------- | ------------------------------------------------------------ |
| First Name           | string  | Yes      | The employee's legal first name.                             |
| Last Name            | string  | Yes      | The employee's legal last name.                              |
| Email                | string  | No       | Personal email; required for employee self-onboarding.       |
| Date of Birth        | date    | No       | The employee's date of birth (YYYY-MM-DD).                   |
| SSN                  | secret  | No       | The employee's Social Security number (9 digits, no dashes). |
| Middle Initial       | string  | No       | The employee's middle initial.                               |
| Preferred First Name | string  | No       | The name the employee goes by, if different.                 |
| Self Onboarding      | boolean | No       | Invite the employee to enter their own details in Gusto.     |

**Outputs**

| Field             | Type   | Description                       |
| ----------------- | ------ | --------------------------------- |
| Employee UUID     | string | The new employee's UUID.          |
| First Name        | string | The stored first name.            |
| Last Name         | string | The stored last name.             |
| Email             | string | The stored personal email.        |
| Onboarding Status | string | The employee's onboarding status. |
| Version           | string | Gusto's record version token.     |

#### Get Employee

Fetch a single Gusto employee.

**Required permissions:** `employees:read`.

**Inputs**

| Field    | Type            | Required | Description                                                       |
| -------- | --------------- | -------- | ----------------------------------------------------------------- |
| Employee | select (string) | Yes      | The employee to fetch. Options load from the selected connection. |

**Outputs**

| Field    | Type   | Description                   |
| -------- | ------ | ----------------------------- |
| Employee | dict   | The employee record.          |
| Version  | string | Gusto's record version token. |

#### Update Employee

Update a Gusto employee's basic details.

**Required permissions:** `employees:read`, `employees:write`.

**Inputs**

| Field                | Type            | Required | Description                                                        |
| -------------------- | --------------- | -------- | ------------------------------------------------------------------ |
| Employee             | select (string) | Yes      | The employee to update. Options load from the selected connection. |
| First Name           | string          | No       | New legal first name.                                              |
| Last Name            | string          | No       | New legal last name.                                               |
| Email                | string          | No       | New personal email.                                                |
| Date of Birth        | date            | No       | New date of birth (YYYY-MM-DD).                                    |
| SSN                  | secret          | No       | New Social Security number (9 digits, no dashes).                  |
| Middle Initial       | string          | No       | New middle initial.                                                |
| Preferred First Name | string          | No       | New preferred first name.                                          |

**Outputs**

| Field         | Type   | Description                       |
| ------------- | ------ | --------------------------------- |
| Employee UUID | string | The employee's UUID.              |
| First Name    | string | The stored first name.            |
| Last Name     | string | The stored last name.             |
| Email         | string | The stored personal email.        |
| Version       | string | Gusto's new record version token. |

#### List Payrolls

List payrolls of the connected Gusto company.

**Required permissions:** `payrolls:read`.

**Inputs**

| Field               | Type                      | Required | Description                                                                                      |
| ------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
| Processing Statuses | multiple\_select (string) | No       | Filter by processing status (default: processed only). Available values: Processed, Unprocessed. |
| Payroll Types       | multiple\_select (string) | No       | Filter by payroll type (default: regular only). Available values: Regular, Off-cycle, External.  |
| Start Date          | date                      | No       | Earliest check date to include (YYYY-MM-DD).                                                     |
| End Date            | date                      | No       | Latest check date to include (YYYY-MM-DD).                                                       |
| Include Totals      | boolean                   | No       | Include company-wide totals on each payroll.                                                     |
| Limit               | integer                   | No       | Maximum payrolls to return (default 25).                                                         |

**Outputs**

| Field       | Type        | Description                                          |
| ----------- | ----------- | ---------------------------------------------------- |
| Payrolls    | dict\_array | The company's payrolls.                              |
| Total Count | integer     | Total matching payrolls, as reported by Gusto.       |
| Has More    | boolean     | True if more payrolls exist beyond the returned set. |

#### Get Payroll

Fetch a single Gusto payroll.

**Required permissions:** `payrolls:read`.

**Inputs**

| Field          | Type            | Required | Description                                                      |
| -------------- | --------------- | -------- | ---------------------------------------------------------------- |
| Payroll        | select (string) | Yes      | The payroll to fetch. Options load from the selected connection. |
| Include Totals | boolean         | No       | Include company-wide totals.                                     |

**Outputs**

| Field     | Type    | Description                             |
| --------- | ------- | --------------------------------------- |
| Payroll   | dict    | The payroll record.                     |
| Processed | boolean | Whether the payroll has been processed. |

#### Run Payroll

Submit an unprocessed Gusto payroll to be calculated and run.

**Required permissions:** `payrolls:run`, `payrolls:read`.

**Inputs**

| Field               | Type            | Required | Description                                                                |
| ------------------- | --------------- | -------- | -------------------------------------------------------------------------- |
| Payroll             | select (string) | Yes      | The unprocessed payroll to run. Options load from the selected connection. |
| Wait for Processing | boolean         | No       | Poll until Gusto finishes processing (default: true).                      |
| Timeout (seconds)   | integer         | No       | How long to wait for processing (default 120s).                            |

**Outputs**

| Field        | Type    | Description                                                      |
| ------------ | ------- | ---------------------------------------------------------------- |
| Payroll UUID | string  | The submitted payroll's UUID.                                    |
| Submitted    | boolean | Whether Gusto accepted the submission.                           |
| Processed    | boolean | Whether the payroll finished processing before returning.        |
| Check Date   | string  | The payroll's check date.                                        |
| Payroll      | dict    | The payroll's latest state.                                      |
| Warning      | string  | Set when the submission succeeded but its status is unconfirmed. |

#### Get Time Off Requests

Fetch the time-off requests of the connected Gusto company.

**Required permissions:** `time_off_requests:read`.

**Inputs**

| Field      | Type | Required | Description                                    |
| ---------- | ---- | -------- | ---------------------------------------------- |
| Start Date | date | No       | Earliest request date to include (YYYY-MM-DD). |
| End Date   | date | No       | Latest request date to include (YYYY-MM-DD).   |

**Outputs**

| Field             | Type        | Description                      |
| ----------------- | ----------- | -------------------------------- |
| Time Off Requests | dict\_array | The company's time-off requests. |
| Count             | integer     | Number of requests returned.     |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/gusto.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
