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

# Gusto

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the Gusto instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.gusto.com`.

### Supported objects

The Gusto connector supports reading from the following objects:

* [admins](https://docs.gusto.com/app-integrations/reference)
* [companies](https://docs.gusto.com/app-integrations/reference)
* [company\_benefits](https://docs.gusto.com/app-integrations/reference)
* [contractor\_payments](https://docs.gusto.com/app-integrations/reference)
* [contractors](https://docs.gusto.com/app-integrations/reference)
* [custom\_fields](https://docs.gusto.com/app-integrations/reference)
* [departments](https://docs.gusto.com/app-integrations/reference)
* [earning\_types](https://docs.gusto.com/app-integrations/reference)
* [employee\_benefits](https://docs.gusto.com/app-integrations/reference)
* [employees](https://docs.gusto.com/app-integrations/reference)
* [garnishments](https://docs.gusto.com/app-integrations/reference)
* [home\_addresses](https://docs.gusto.com/app-integrations/reference)
* [jobs](https://docs.gusto.com/app-integrations/reference)
* [locations](https://docs.gusto.com/app-integrations/reference)
* [pay\_periods](https://docs.gusto.com/app-integrations/reference)
* [pay\_schedules](https://docs.gusto.com/app-integrations/reference)
* [payrolls](https://docs.gusto.com/app-integrations/reference)
* [time\_off\_activities](https://docs.gusto.com/app-integrations/reference)
* [work\_addresses](https://docs.gusto.com/app-integrations/reference)

The Gusto connector supports writing to the following objects:

* [admins](https://docs.gusto.com/app-integrations/reference)
* [companies](https://docs.gusto.com/app-integrations/reference)
* [company\_benefits](https://docs.gusto.com/app-integrations/reference)
* [compensations](https://docs.gusto.com/app-integrations/reference)
* [contractor\_payments](https://docs.gusto.com/app-integrations/reference)
* [contractors](https://docs.gusto.com/app-integrations/reference)
* [departments](https://docs.gusto.com/app-integrations/reference)
* [earning\_types](https://docs.gusto.com/app-integrations/reference)
* [employee\_benefits](https://docs.gusto.com/app-integrations/reference)
* [employees](https://docs.gusto.com/app-integrations/reference)
* [garnishments](https://docs.gusto.com/app-integrations/reference)
* [home\_addresses](https://docs.gusto.com/app-integrations/reference)
* [jobs](https://docs.gusto.com/app-integrations/reference)
* [locations](https://docs.gusto.com/app-integrations/reference)
* [pay\_periods](https://docs.gusto.com/app-integrations/reference)
* [pay\_schedules](https://docs.gusto.com/app-integrations/reference)
* [payrolls](https://docs.gusto.com/app-integrations/reference)
* [work\_addresses](https://docs.gusto.com/app-integrations/reference)

### Example integration

For an example manifest file of a Gusto integration, visit our [samples repo on GitHub](https://github.com/amp-labs/samples/blob/main/gusto/amp.yaml).

## Before you get started

To connect Gusto with Ampersand, you will need a [Gusto Developer Account](https://dev.gusto.com/).

Once your account is created, you'll need to register an application in the Gusto Developer Portal and obtain the following credentials:

* Client ID
* Client Secret

You will then use these credentials to connect your application to Ampersand.

### Creating a Gusto app

1. Log in to the [Gusto Developer Portal](https://dev.gusto.com/).

2. Navigate to the **Applications** tab and click **Create Application**.

3. Enter the following details for your application:
   * **Application Name**: The name of your app.
   * **Purpose**: A description of your integration.

4. Under **Redirect URIs**, add: `https://api.withampersand.com/callbacks/v1/oauth`

5. Click **Create**. Note the **Client ID** and **Client Secret**. You will need these to connect your app to Ampersand.

For more details, see the [Gusto Authentication documentation](https://docs.gusto.com/app-integrations/docs/authentication).

### Add your Gusto app info to Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to create a Gusto integration.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/Bx3tggG51e0liOp-/images/provider-guides/31a6a12-Ampersand.png?fit=max&auto=format&n=Bx3tggG51e0liOp-&q=85&s=7ebd893fd2a976ebe7cf8af53f8581b8" alt="Ampersand Project Selection" width="2244" height="442" data-path="images/provider-guides/31a6a12-Ampersand.png" />

3. Select **Provider Apps**.

4. Select **Gusto** from the **Provider** list.

5. Enter the **Client ID** and **Client Secret** obtained from your Gusto app.

6. Click **Save Changes**.

## Using the connector

To start integrating with Gusto:

* Create a manifest file like the [example above](#example-integration).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for OAuth authorization.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.