Connect your loyalty program in Gusto without researching its API, registering in a developer program, and getting your application approved. We take care of authentication, secure credentials storage, and token refreshes so you don't have to.

Gusto

Add employees and contractors to a department

Add people to a department

Returns an object containing individual contractor payments, within a given time period, including totals.

Get contractor payments for a company

Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent effective_date.

Create a compensation

The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity. Supports home address effective dating and courtesy withholding.

Create an employee's home address

The work address of an employee describes when an employee began working at an associated company location.

Create an employee work address

Year-to-date benefit amounts from a different company represents the amount of money added to an employee's plan during a current year, made outside of the current contribution when they were employed at a different company.

Create year-to-date benefit amounts from a different company

Deactivate an earning type

Deletes a company benefit if there are no employee benefits associated with it, no payroll items associated with it, and if the benefit is not managed by a Partner or by Gusto (type must be 'External').

Delete a company benefit

Delete a department. You cannot delete a department until all employees and contractors have been removed.

Delete a department

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

Delete an employee benefit

Used for deleting an employee's home address. Cannot delete the employee's active home address.

Delete an employee's home address

Used for deleting an employee's work address. Cannot delete the employee's active work address.

Delete an employee's work address

Deletes a specific job that an employee holds.

Use this endpoint to delete an employee who is in onboarding. Deleting an onboarded employee is not allowed. Please check out the Terminations api if you need to terminate an onboarded employee.

Delete an onboarding employee

Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit. Note that company benefits can be deactivated only when no employees are enrolled. When with_employee_benefits parameter with true value is passed, employee_benefits:read scope is required to return employee_benefits.

Get a company benefit

Get a company.
The employees:read scope is required to return home_address and non-work locations.
The company_admin:read scope is required to return primary_payroll_admin.
The signatories:read scope is required to return primary_signatory.
scope: companies:read

Get a company

Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent effective_date.

Get a Compensation

Get the representation of a contractor (individual or business) in Gusto.

Get a contractor

Get a department given the UUID

Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments.

Get a garnishment

Get the representation of a job in Gusto.

Get a job

Get the representation of an address in Gusto.

Get a location

The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.

Get a pay schedule

Get a single contractor payment

Returns a payroll. If payroll is calculated or processed, will return employee_compensations and totals.

Get a single payroll

Get a supported benefit by ID

Returns an array of all employee benefits for this employee. Benefits containing PHI are only visible to applications with the employee_benefits:read:phi scope.

Get all benefits for an employee

Returns all benefits supported by Gusto. The benefit object in Gusto contains high level information about a particular benefit type and its tax considerations. When companies choose to offer a benefit, they are creating a Company Benefit object associated with a particular benefit.

Get all benefits supported by Gusto

Get all of the departments for a given company with the employees and contractors assigned to that department.

Get all departments of a company

A payroll item in Gusto is associated to an earning type to name the type of earning described by the payroll item.

Get all earning types for a company

Get an employee benefit

Returns a list of the employee's custom fields.

Get an employee's custom fields

The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity. Supports home address effective dating and courtesy withholding.

Get an employee's home address

Returns a list of an employee's work addresses. Each address includes its effective date and a boolean signifying if it is the currently active work address.

Get an employee's work addresses

The work address of an employee is used for payroll tax purposes.

Get an employee work address

Get the representation of an employee in Gusto.

Get an employee

Returns field requirements for the requested benefit type.

Get benefit fields requirements by ID

Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit. Note that company benefits can be deactivated only when no employees are enrolled. Benefits containing PHI are only visible to applications with the company_benefits:read:phi scope.

Get benefits for a company

Company locations represent all addresses associated with a company. These can be filing addresses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.

Get Companies Company Id Locations

Returns summary benefit data for the requested company benefit id. Benefits containing PHI are only visible to applications with the company_benefits:read:phi scope.

Get company benefit summary by company benefit id.

Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent effective_date. By default the API returns only the current compensation - see the include query parameter for retrieving all compensations. Note: Currently the API does not support creating multiple compensations per job - creating a compensation with the same job_uuid as another will fail with a relevant error. Use flsa_status to determine if an employee is eligible for overtime.

Get compensations for a job

Get all contractors, active and inactive, individual and business, for a company.

Get all contractors of a company

Get employee time off activities

Get all of the employees, onboarding, active and terminated, for a given company.

Get garnishments for an employee

Get all of the jobs that an employee holds.

Get minimum wages for a location

Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened. To begin submitting information for a given payroll, we need to agree on the time period. By default, this endpoint returns pay periods starting from 6 months ago to the date today. Use the start_date and end_date parameters to change the scope of the response. End dates can be up to 3 months in the future and there is no limit on start dates.

Get pay periods for a company

Get V1 Companies Company Id Locations

This endpoint will build the payroll and get it ready for making updates. This includes adding/removing eligible employees from the Payroll and updating the check_date, payroll_deadline, and payroll_status_meta dates & times.

Prepare a payroll for update

Remove employees and contractors from a department

Remove people from a department

Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit. Note that company benefits can be deactivated only when no employees are enrolled.

Update a company benefit

Update a compensation

Update a contractor. Watch out when changing a contractor's type (when the contractor is finished onboarding). Specifically, changing contractor type can be dangerous since Gusto won’t recognize and file two separate 1099s if they simply change from business to individual.

Update a contractor

Update a garnishment

Update a job

Update a location

This endpoint allows you to update information for one or more employees for a specific unprocessed payroll. You cannot modify the structure of the payroll object through this endpoint, only values of the fields included in the payroll.

Update a payroll by ID

Update an earning type

Update an employee benefit

Update an employee's home address

Update an employee work address

Update an employee

Returns scope and resource information associated with the current access token.

Get info about the current access token

Exchange a refresh token for a new access token.

The previous `refresh_token` will be revoked on the first usage of the new `access_token`.

The `expires_in` value is provided in seconds from when the `access_token` was generated.

Refresh access token

### Overview
The company provisioning API provides a way to create a Gusto company as part of your integration. When you successfully call the API, the API does the following:
* Creates a new company in Gusto.
* Creates a new user in Gusto.
* Makes the new user the primary payroll administrator of the new company.
* Sends a welcome email to the new user.
In the response, you will receive an account claim URL. Redirect the user to this URL to complete their account setup inside of Gusto

> 📘 Token Authentication
>
> This endpoint uses the [organization level api token and the Token scheme with HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/authentication#api-token-authentication).

Create a company

Get a company.         
The employees:read scope is required to return home_address and non-work locations.         
The company_admin:read scope is required to return primary_payroll_admin.         
The signatories:read scope is required to return primary_signatory.         

scope: `companies:read`

Returns a list of the custom fields of the company. Useful when you need to know the schema of custom fields for an entire company

scope: `companies:read`

Get the custom fields of a company

Company locations represent all addresses associated with a company. These can be filing addresses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.

Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.

scope: `companies.write`

Create a company location

Company locations represent all addresses associated with a company. These can be filing addresses, mailing addresses, and/or work locations; one address may serve multiple, or all, purposes.

Since all company locations are subsets of locations, retrieving or updating an individual record should be done via the locations endpoints.

scope: `companies:read`

Get company locations

Update a location.

scope: `companies.write`

Get minimum wages for a location

scope: `companies:read`

The pay schedule object in Gusto captures the details of when employees work and when they should be paid. A company can have multiple pay schedules.

scope: `pay_schedules:read`

Get the pay schedules for a company

Pay periods are the foundation of payroll. Compensation, time & attendance, taxes, and expense reports all rely on when they happened. To begin submitting information for a given payroll, we need to agree on the time period.

By default, this endpoint returns pay periods starting from 6 months ago to the date today.  Use the `start_date` and `end_date` parameters to change the scope of the response.  End dates can be up to 3 months in the future and there is no limit on start dates.

Starting in version '2023-04-01', the eligible_employees attribute was removed from the response.  The eligible employees for a payroll are determined by the employee_compensations returned from the payrolls#prepare endpoint.

scope: `payrolls:read`

When a payroll admin terminates an employee and selects "Dismissal Payroll" as the employee's final payroll, their last pay period will appear on the list.

This endpoint returns the unprocessed pay periods for past and future terminated employees in a given company.

scope: `payrolls:read`

Get termination pay periods for a company

This endpoint returns the current pay schedule assignment for a company, with pay schedule and employee/department mappings depending on the pay schedule type.

scope: `pay_schedules:read`

Get pay schedule assignments for a company

Create an employee.

scope: `employees:manage`

Create an employee

Get all of the employees, onboarding, active and terminated, for a given company.

scope: `employees:read`

Get employees of a company

Create a department

scope: `departments:write`

Create a department

Get all of the departments for a given company with the employees and contractors assigned to that department.

scope: `departments:read`

Get a department given the UUID

scope: `departments:read`


Get a department

Update a department

scope: `departments:write`

Update a department

Delete a department. You cannot delete a department until all employees and contractors have been removed.

scope: `departments:write`


Add employees and contractors to a department

scope: `departments:write`


Remove employees and contractors from a department

scope: `departments:write`


Get an employee.

scope: `employees:read`


Update an employee.

scope: `employees:write`

Use this endpoint to delete an employee who is in onboarding. Deleting
an onboarded employee is not allowed. Please check out the Terminations api
if you need to terminate an onboarded employee.

scope: `employees:manage`

Terminations are created whenever an employee is scheduled to leave the company. The only things required are an effective date (their last day of work) and whether they should receive their wages in a one-off termination payroll or with the rest of the company.

Note that some states require employees to receive their final wages within 24 hours (unless they consent otherwise,) in which case running a one-off payroll may be the only option.

scope: `employments:write`

Create an employee termination

Terminations are created whenever an employee is scheduled to leave the company. The only things required are an effective date (their last day of work) and whether they should receive their wages in a one-off termination payroll or with the rest of the company.

Note that some states require employees to receive their final wages within 24 hours (unless they consent otherwise,) in which case running a one-off payroll may be the only option.

scope: `employments:read`

Get terminations for an employee

Delete an employee termination.

scope: `employments:write`

Delete an employee termination

Update an employee termination

Rehire is created whenever an employee is scheduled to return to the company.

scope: `employments:write`

Create an employee rehire

Update an employee's rehire.

scope: `employments:write`

Update an employee rehire

Retrieve an employee's rehire, which contains information on when the employee returns to work.

scope: `employments:read`

Get an employee rehire

Delete an employee rehire. An employee rehire cannot be deleted if it's active (past effective date).

scope: `employments:write`

Delete an employee rehire

Retrieve the employment history for a given employee, which includes termination and rehire.

scope: `employments:read`

Get employment history for an employee

The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.

Supports home address effective dating and courtesy withholding.

scope: `employees:read`

White Label Loyalty + Gusto integration

About Gusto

Similar Integrations

Rippling HR

Google Workspace

ADP Workforce Now

Personio

Benefits of White Label Loyalty + Gusto

Integrate now!

Automate desired actions with Gusto