Gusto API Integration Profile
Information and guides about integrating with Gusto API
Add Gusto Integration to Your App- Get info about the current access token
Returns scope and resource information associated with the current access token.
- Refresh access token
Exchange a refresh token for a new access token.
The previous
refresh_tokenwill be revoked on the first usage of the newaccess_token.The
expires_invalue is provided in seconds from when theaccess_tokenwas generated. - Create a company
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.
- Get a company
Get a company.
scope is required to return home_address and non-work locations.
The employees
The company_admin scope is required to return primary_payroll_admin.
The signatories scope is required to return primary_signatory.scope:
companies:read - Get the custom fields of a company
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 - 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.write - Get company locations
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 a location
Get a location.
scope:
companies:read - Update a location
Update a location.
scope:
companies.write - Get minimum wages for a location
Get minimum wages for a location
scope:
companies:read