A Developer's Best Friend
Welcome to Gusto's API documentation. This site serves as both a technical reference for the endpoints available and a general overview of payroll. We designed the objects and their properties to require as little domain-specific payroll knowledge as possible.
Gusto has a closed API system and a full near-term roadmap. We do occasionally support new integrations for products that could potentially benefit many or all of our small businesses. If you'd like to be considered for a future integration partnership, please email email@example.com.
Existing partners have been given API credentials. These include the application id and secret necessary to interact with any part of the Gusto API. Next, you'll want to successfully authenticate a user using OAuth. The Authentication Example has everything you need to get started.
Pay periods are the combination of a company, a subset of its employees, and a time range. Not every employee at a company will be a part of every payroll. One-off (or'off-cycle') payrolls are run for special events such as hiring or termination, and employees can be excluded from payrolls.
Regular payrolls are tied to a specific pay periods, and all associated information - vacation & sick time, hours worked, bonuses, etc. - should be applied to that time range.
By using the Gusto API, you are agreeing to the following terms and conditions.