# App Integrations Documentation > Documentation for App Integrations ## Guides: Basics - [Introduction](https://docs.gusto.com/app-integrations/docs/introduction.md) - [App Integrations vs. Gusto Embedded](https://docs.gusto.com/app-integrations/docs/app-integrations-vs-embedded-payroll.md) - [Security Review](https://docs.gusto.com/app-integrations/docs/security-review.md) - [Authentication](https://docs.gusto.com/app-integrations/docs/authentication.md) - [System Access Tokens](https://docs.gusto.com/app-integrations/docs/system-access-tokens.md) - [OAuth2](https://docs.gusto.com/app-integrations/docs/oauth2.md) - [Strict Access](https://docs.gusto.com/app-integrations/docs/strict-access.md) - [Pagination](https://docs.gusto.com/app-integrations/docs/pagination.md) - [API Versioning](https://docs.gusto.com/app-integrations/docs/api-versioning.md) - [Getting Setup](https://docs.gusto.com/app-integrations/docs/getting-setup.md) - [Version Upgrade Guide](https://docs.gusto.com/app-integrations/docs/version-upgrade-guide.md) - [Scopes](https://docs.gusto.com/app-integrations/docs/scopes.md) - [Rate Limits](https://docs.gusto.com/app-integrations/docs/rate-limits.md) - [Webhooks](https://docs.gusto.com/app-integrations/docs/webhooks.md): Efficiently integrate Gusto's real-time event data into your application - [Best Practices](https://docs.gusto.com/app-integrations/docs/best-practices.md) - [Webhook Events](https://docs.gusto.com/app-integrations/docs/webhook-events.md) - [Bank Account Events](https://docs.gusto.com/app-integrations/docs/bank-account-events.md) - [Company Events](https://docs.gusto.com/app-integrations/docs/company-events.md) - [Company Benefit Events](https://docs.gusto.com/app-integrations/docs/company-benefit-events.md) - [Contractor Events](https://docs.gusto.com/app-integrations/docs/contractor-events.md) - [Contractor Payment Events](https://docs.gusto.com/app-integrations/docs/contractor-payment-events.md) - [Employee Events](https://docs.gusto.com/app-integrations/docs/employee-events.md) - [Employee Home Address Events](https://docs.gusto.com/app-integrations/docs/employee-home-address-events.md) - [Employee Work Address Events](https://docs.gusto.com/app-integrations/docs/employee-work-address-events.md) - [Employee Benefit Events](https://docs.gusto.com/app-integrations/docs/employee-benefit-events.md) - [Employee Job Compensation Events](https://docs.gusto.com/app-integrations/docs/employee-job-compensation-events.md) - [External Payroll Events](https://docs.gusto.com/app-integrations/docs/external-payroll-events.md) - [Fast Ach Config Events](https://docs.gusto.com/app-integrations/docs/fast-ach-config-events.md) - [Form Events](https://docs.gusto.com/app-integrations/docs/form-events.md) - [Location Events](https://docs.gusto.com/app-integrations/docs/location-events.md) - [Payroll Events](https://docs.gusto.com/app-integrations/docs/payroll-events.md) - [Pay Schedule Events](https://docs.gusto.com/app-integrations/docs/pay-schedule-events.md) - [Signatory Events](https://docs.gusto.com/app-integrations/docs/signatory-events.md) - [Error Categories](https://docs.gusto.com/app-integrations/docs/error-categories.md) ## Guides: Guides - [Gusto Experience Principles](https://docs.gusto.com/app-integrations/docs/gusto-experience-principles.md) - [Syncing Employees](https://docs.gusto.com/app-integrations/docs/syncing-employees.md) - [Syncing Time Tracking Data](https://docs.gusto.com/app-integrations/docs/syncing-time-tracking-data.md) - [Jobs and Compensations](https://docs.gusto.com/app-integrations/docs/jobs-and-compensations.md) - [Payrolls](https://docs.gusto.com/app-integrations/docs/updating-payrolls.md) ## Guides: Contact - [Contact Gusto](https://docs.gusto.com/app-integrations/docs/contact-gusto-1.md) ## API Reference: Gusto API - [Get info about the current access token](https://docs.gusto.com/app-integrations/reference/get-v1-token-info.md): Returns scope and resource information associated with the current access token. Use this endpoint to verify the following for the current access token: * Resource (company, employee, contractor, or… - [Revoke access token](https://docs.gusto.com/app-integrations/reference/revoke-access-token.md): Revokes the given access token. After revoking, this token can no longer be used to make requests nor can it be refreshed. - [Disconnect an app integration](https://docs.gusto.com/app-integrations/reference/post-v1-disconnect-app-integration.md): Disconnects the given company from the App Integration associated with the current system access token. If multiple users from that company are authorized with the App Integration, then their tokens… - [Create a System Access Token or Refresh an Access Token](https://docs.gusto.com/app-integrations/reference/oauth-access-token.md): Creates a system access token or refreshes an oauth access token - [Get an employee termination](https://docs.gusto.com/app-integrations/reference/get-v1-terminations-employee_id.md): 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… - [Calculate accruing time off hours](https://docs.gusto.com/app-integrations/reference/post-v1-payrolls-payroll_id-calculate_accruing_time_off_hours.md): Returns a list of accruing time off for each time off policy associated with the employee. Factors affecting the accrued hours: - the time off policy accrual method (whether they get pay per hour… - [Get a time off policy](https://docs.gusto.com/app-integrations/reference/get-v1-time_off_policies-time_off_policy_uuid.md): Get a time off policy scope: `time_off_policies:read` - [Get all time off policies for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_uuid-time_off_policies.md): Get all time off policies for a company scope: `time_off_policies:read` - [Add employees to a time off policy](https://docs.gusto.com/app-integrations/reference/put-v1-time_off_policies-time_off_policy_uuid-add_employees.md): Add employees to a time off policy. Employees are required to have at least one job to be added to a time off policy. Accepts starting balances for non-unlimited policies scope:… - [Get notifications for company](https://docs.gusto.com/app-integrations/reference/get-company-notifications.md): Returns all notifications relevant for the given company. scope: `notifications:read` ## API Reference: Companies - [Create a company](https://docs.gusto.com/app-integrations/reference/post-v1-provision.md): ### 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… - [Get a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies.md): 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… - [Update a company](https://docs.gusto.com/app-integrations/reference/put-v1-companies.md): Update a company. scope: `companies:write` - [Get all the admins at a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-admins.md): Returns a list of all the admins at a company scope: `company_admin:read` - [Get the custom fields of a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-custom_fields.md): 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](https://docs.gusto.com/app-integrations/reference/post-v1-companies-company_id-locations.md): Create a company location, which represents any address associated with a company: mailing addresses, filing addresses, or work locations. A single address may serve multiple, or all, purposes.… - [Get all company locations](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-locations.md): Retrieves all company locations (addresses) associated with a company: mailing addresses, filing addresses, or work locations. A single address may serve multiple, or all, purposes. Since all… - [Get a location](https://docs.gusto.com/app-integrations/reference/get-v1-locations-location_id.md): Get a location. scope: `companies:read` - [Update a location](https://docs.gusto.com/app-integrations/reference/put-v1-locations-location_id.md): Update a location. scope: `companies:write` - [Get minimum wages for a location](https://docs.gusto.com/app-integrations/reference/get-v1-locations-location_uuid-minimum_wages.md): Get minimum wages for a location scope: `companies:read` - [Get the pay schedules for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-pay_schedules.md): Returns all pay schedules for a company. The pay schedule object captures the details of when employees work and when they should be paid. A company can have multiple pay schedules. scope:… - [Get a pay schedule](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-pay_schedules-pay_schedule_id.md): Returns a single pay schedule by UUID. 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:… - [Get pay periods for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-pay_periods.md): 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… - [Get termination pay periods for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-unprocessed_termination_pay_periods.md): 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… - [Get pay schedule assignments for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-pay_schedules-assignments.md): 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` - [Create a custom earning type](https://docs.gusto.com/app-integrations/reference/post-v1-companies-company_id-earning_types.md): Create a custom earning type. If an inactive earning type exists with the same name, this will reactivate it instead of creating a new one. scope: `payrolls:write` - [Get all earning types for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-earning_types.md): A payroll item in Gusto is associated to an earning type to name the type of earning described by the payroll item. #### Default Earning Type Certain earning types are special because they have tax… - [Update an earning type](https://docs.gusto.com/app-integrations/reference/put-v1-companies-company_id-earning_types-earning_type_uuid.md): Update an earning type. scope: `payrolls:write` - [Deactivate an earning type](https://docs.gusto.com/app-integrations/reference/delete-v1-companies-company_id-earning_types-earning_type_uuid.md): Deactivate an earning type. scope: `payrolls:write` - [Get all payrolls for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-payrolls.md): Returns a list of payrolls for a company. You can change the payrolls returned by updating the processing_status, payroll_types, start_date, & end_date params. By default, will return processed,… - [Get a single payroll](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-payrolls-payroll_id.md): Returns a payroll. If payroll is calculated or processed, will return employee_compensations and totals. Results are paginated, with a maximum page size of 100 employee_compensations. Notes: * Hour… - [Update a payroll by ID](https://docs.gusto.com/app-integrations/reference/put-v1-companies-company_id-payrolls.md): This endpoint allows you to update information for one or more employees for a specific **unprocessed** payroll. You can think of the **unprocessed** payroll object as a template of fields that you… - [Prepare a payroll for update](https://docs.gusto.com/app-integrations/reference/put-v1-companies-company_id-payrolls-payroll_id-prepare.md): Prepares an unprocessed payroll for update, including: adding eligible employees to off-cycle payrolls that support multiple employees (`Bonus`, `Correction`, and `Adhoc`), and updating `check_date`,… - [Create a company benefit](https://docs.gusto.com/app-integrations/reference/post-v1-companies-company_id-company_benefits.md): 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… - [Get benefits for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-company_benefits.md): 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… - [Get a company benefit](https://docs.gusto.com/app-integrations/reference/get-v1-company_benefits-company_benefit_id.md): 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… - [Update a company benefit](https://docs.gusto.com/app-integrations/reference/put-v1-company_benefits-company_benefit_id.md): 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… - [Delete a company benefit](https://docs.gusto.com/app-integrations/reference/delete-v1-company_benefits-company_benefit_id.md): The following must be true in order to delete a company benefit - There are no employee benefits associated with the company benefit - There are no payroll items associated with the company… - [Get all supported benefits](https://docs.gusto.com/app-integrations/reference/get-v1-benefits.md): 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… - [Get a supported benefit](https://docs.gusto.com/app-integrations/reference/get-v1-benefits-benefit_id.md): Returns a benefit 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,… - [Get company benefit summary by company benefit id.](https://docs.gusto.com/app-integrations/reference/get-v1-benefits-company_benefit_id-summary.md): 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. scope: `company_benefits:read` - [Get all employee benefits for a company benefit](https://docs.gusto.com/app-integrations/reference/get-v1-company_benefits-company_benefit_id-employee_benefits.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment. Returns an array of all employee benefits enrolled… - [Bulk update employee benefits for a company benefit](https://docs.gusto.com/app-integrations/reference/put-v1-company_benefits-company_benefit_id-employee_benefits.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment. Create or update(if the employee is already enrolled… - [Get benefit fields requirements by benefit type](https://docs.gusto.com/app-integrations/reference/get-v1-benefits-benefits_id-requirements.md): Returns the field requirements for a given benefit type. scope: `benefits:read` - [Get contribution exclusions for a company benefit](https://docs.gusto.com/app-integrations/reference/get-v1-company_benefits-company_benefit_id-contribution_exclusions.md): Returns all contributions for a given company benefit and whether they are excluded or not. Currently this endpoint only works for 401-k and Roth 401-k benefit types. scope: `company_benefits:read` - [Update contribution exclusions for a company benefit](https://docs.gusto.com/app-integrations/reference/put-v1-company_benefits-company_benefit_id-contribution_exclusions.md): Updates contribution exclusions for a given company benefit. Currently this endpoint only works for 401-k and Roth 401-k benefit types. scope: `company_benefits:write` - [Get all time sheets for a company](https://docs.gusto.com/app-integrations/reference/get-companies-company_uuid-time_tracking-time_sheets.md): Fetch all company's time sheets. Time sheets represent the time worked by an employee or contractor for a given time range. Hours are classified by pay classification, and can be regular, overtime,… - [Create a time sheet](https://docs.gusto.com/app-integrations/reference/post-companies-company_uuid-time_tracking-time_sheets.md): Create a time sheet for a company. Time sheets represent the time worked by an employee or contractor for a given time range. Hours are classified by pay classification, and can be regular,… - [Get a time sheet](https://docs.gusto.com/app-integrations/reference/get-time_tracking-time_sheets-time_sheet_uuid.md): Fetch a time sheet. Time sheets represent the time worked by an employee or contractor for a given time range. Hours are classified by pay classification, and can be regular, overtime, or double… - [Update a time sheet](https://docs.gusto.com/app-integrations/reference/put-time_tracking-time_sheets-time_sheet_uuid.md): Update a time sheet. Time sheets represent the time worked by an employee or contractor for a given time range. Hours are classified by pay classification, and can be regular, overtime, or double… - [Delete a time sheet](https://docs.gusto.com/app-integrations/reference/delete-time_tracking-time_sheets-time_sheet_uuid.md): Delete a company's time sheet. Time sheets represent the time worked by an employee or contractor for a given time range. Hours are classified by pay classification, and can be regular, overtime, or… - [Create a payroll sync](https://docs.gusto.com/app-integrations/reference/post-companies-company_uuid-time_tracking-payroll_syncs.md): Initiate a payroll sync for a company. A payroll sync takes approved time sheet data and syncs it to the company's payroll. ### Asynchronous processing This endpoint triggers an asynchronous… - [Get a payroll sync](https://docs.gusto.com/app-integrations/reference/get-time_tracking-payroll_syncs-payroll_sync_uuid.md): Fetch a payroll sync. A payroll sync represents the result of syncing approved time sheet data to payroll. Use this endpoint to check the status of a previously initiated sync. scope:… - [Get time off requests for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-time_off_requests.md): Get all time off requests, past and present, for a company. In order to reduce the number of time off requests returned in a single response, or to retrieve time off requests from a time period of… - [Create a department](https://docs.gusto.com/app-integrations/reference/post-departments.md): Create a department scope: `departments:write` - [Get all departments of a company](https://docs.gusto.com/app-integrations/reference/get-companies-departments.md): Get all of the departments for a given company with the employees and contractors assigned to that department. scope: `departments:read` - [Get a department](https://docs.gusto.com/app-integrations/reference/get-department.md): Get a department given the UUID scope: `departments:read` - [Update a department](https://docs.gusto.com/app-integrations/reference/put-departments.md): Update a department scope: `departments:write` - [Delete a department](https://docs.gusto.com/app-integrations/reference/delete-department.md): Delete a department. You cannot delete a department until all employees and contractors have been removed. scope: `departments:write` - [Add people to a department](https://docs.gusto.com/app-integrations/reference/put-add-people-to-department.md): Add employees and contractors to a department scope: `departments:write` - [Remove people from a department](https://docs.gusto.com/app-integrations/reference/put-remove-people-from-department.md): Remove employees and contractors from a department scope: `departments:write` ## API Reference: W2 Employees - [Get employees of a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-employees.md): Get all of the employees, onboarding, active and terminated, for a given company. Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information.… - [Create an employee](https://docs.gusto.com/app-integrations/reference/post-v1-employees.md): Create an employee. scope: `employees:manage` - [Get an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees.md): Get an employee. Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information. When retrieving employee job data, these fields (`rate`,… - [Update an employee.](https://docs.gusto.com/app-integrations/reference/put-v1-employees.md): Update an employee. scope: `employees:write` - [Delete an onboarding employee](https://docs.gusto.com/app-integrations/reference/delete-v1-employee.md): Use this endpoint to delete an employee who is in onboarding. Deleting an onboarded employee is not allowed and will return a 422 response. Please check out the Terminations api if you need to… - [Get an employee's custom fields](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-custom_fields.md): Returns a list of the employee's custom fields. scope: `employees:read` - [Get employee time off activities](https://docs.gusto.com/app-integrations/reference/get-version-employees-time_off_activities.md): Get employee time off activities. scope: `employee_time_off_activities:read` - [Create an employee termination](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-terminations.md): Create a termination for an employee. 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… - [Get terminations for an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-terminations.md): 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… - [Delete an employee termination](https://docs.gusto.com/app-integrations/reference/delete-v1-employees-employee_id-terminations.md): Delete an employee termination. scope: `employments:write` - [Update an employee termination](https://docs.gusto.com/app-integrations/reference/put-v1-terminations-employee_id.md): 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… - [Create an employee rehire](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-rehire.md): Rehire is created whenever an employee is scheduled to return to the company. scope: `employments:write` - [Update an employee rehire](https://docs.gusto.com/app-integrations/reference/put-v1-employees-employee_id-rehire.md): Update an employee's rehire. scope: `employments:write` - [Get an employee rehire](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-rehire.md): Retrieve an employee's rehire, which contains information on when the employee returns to work. scope: `employments:read` - [Delete an employee rehire](https://docs.gusto.com/app-integrations/reference/delete-v1-employees-employee_id-rehire.md): Delete an employee rehire. An employee rehire cannot be deleted if it's active (past effective date). scope: `employments:write` - [Get employment history for an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-employment_history.md): Retrieve the employment history for a given employee, which includes termination and rehire. scope: `employments:read` - [Get an employee's home addresses](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-home_addresses.md): 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… - [Create an employee's home address](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-home_addresses.md): 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… - [Get an employee's home address](https://docs.gusto.com/app-integrations/reference/get-v1-home_addresses-home_address_uuid.md): 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… - [Update an employee's home address](https://docs.gusto.com/app-integrations/reference/put-v1-home_addresses-home_address_uuid.md): 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… - [Delete an employee's home address](https://docs.gusto.com/app-integrations/reference/delete-v1-home_addresses-home_address_uuid.md): Used for deleting an employee's home address. Cannot delete the employee's active home address. scope: `employees:write` - [Get an employee's work addresses](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-work_addresses.md): 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. scope: `employees:read` - [Create an employee work address](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-work_addresses.md): The work address of an employee describes when an employee began working at an associated company location. scope: `employees:manage` - [Get an employee work address](https://docs.gusto.com/app-integrations/reference/get-v1-work_addresses-work_address_uuid.md): The work address of an employee is used for payroll tax purposes. scope: `employees:read` - [Update an employee work address](https://docs.gusto.com/app-integrations/reference/put-v1-work_addresses-work_address_uuid.md): The work address of an employee is used for payroll tax purposes. scope: `employees:manage` - [Delete an employee's work address](https://docs.gusto.com/app-integrations/reference/delete-v1-work_addresses-work_address_uuid.md): Used for deleting an employee's work address. Cannot delete the employee's active work address. scope: `employees:manage` - [Get compensations for a job](https://docs.gusto.com/app-integrations/reference/get-v1-jobs-job_id-compensations.md): 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… - [Create a compensation](https://docs.gusto.com/app-integrations/reference/post-v1-compensations-compensation_id.md): 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… - [Get a compensation](https://docs.gusto.com/app-integrations/reference/get-v1-compensations-compensation_id.md): 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… - [Update a compensation](https://docs.gusto.com/app-integrations/reference/put-v1-compensations-compensation_id.md): 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… - [Delete a compensation](https://docs.gusto.com/app-integrations/reference/delete-v1-compensations-compensation_id.md): 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… - [Create an employee benefit](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-employee_benefits.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment. When the application has the… - [Get all benefits for an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-employee_benefits.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment. Returns an array of all employee benefits for this… - [Get an employee benefit](https://docs.gusto.com/app-integrations/reference/get-v1-employee_benefits-employee_benefit_id.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment. Benefits containing PHI are only visible to… - [Update an employee benefit](https://docs.gusto.com/app-integrations/reference/put-v1-employee_benefits-employee_benefit_id.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment. When the application has the… - [Delete an employee benefit](https://docs.gusto.com/app-integrations/reference/delete-v1-employee_benefits-employee_benefit_id.md): Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee's enrollment. When the application has the… - [Get year-to-date benefit amounts from a different company](https://docs.gusto.com/app-integrations/reference/get-employee-ytd-benefit-amounts-from-different-company.md): Retrieves year-to-date benefit amounts that were contributed at a different company for the specified employee. Returns benefit amounts for the requested tax year (defaults to current year if not… - [Create year-to-date benefit amounts from a different company](https://docs.gusto.com/app-integrations/reference/post-employee-ytd-benefit-amounts-from-different-company.md): 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… - [Get all Section 603 high earner statuses for an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_uuid-section603_high_earner_statuses.md): Get all Section 603 high earner statuses for an employee across all years. Section 603 of the SECURE 2.0 Act applies to employees aged 50 or older whose prior-year FICA wages exceed the IRS… - [Create a Section 603 high earner status](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_uuid-section603_high_earner_statuses.md): Create a Section 603 high earner status for an employee for a specific year. Section 603 of the SECURE 2.0 Act applies to employees aged 50 or older whose prior-year FICA wages exceed the IRS… - [Get a Section 603 high earner status for a specific year](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_uuid-section603_high_earner_statuses-effective_year.md): Get a Section 603 high earner status for an employee for a specific year. Section 603 of the SECURE 2.0 Act applies to employees aged 50 or older whose prior-year FICA wages exceed the IRS… - [Update a Section 603 high earner status](https://docs.gusto.com/app-integrations/reference/patch-v1-employees-employee_uuid-section603_high_earner_statuses-effective_year.md): Update a Section 603 high earner status for an employee for a specific year. Section 603 of the SECURE 2.0 Act applies to employees aged 50 or older whose prior-year FICA wages exceed the IRS… - [Create a garnishment](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-garnishments.md): 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… - [Get garnishments for an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-garnishments.md): 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… - [Get a garnishment](https://docs.gusto.com/app-integrations/reference/get-v1-garnishments-garnishment_id.md): 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… - [Update a garnishment](https://docs.gusto.com/app-integrations/reference/put-v1-garnishments-garnishment_id.md): 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… - [Get child support garnishment data](https://docs.gusto.com/app-integrations/reference/get-v1-garnishments-child_support.md): Agency data and requirements to be used for creating child support garnishments scope: `garnishments:read` - [Create a salary estimate for an employee](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-salary_estimates.md): Create a salary estimate for an employee. This endpoint helps calculate a reasonable salary for S Corp owners based on their occupation, experience level, location, and business revenue. A salary… - [Get a salary estimate](https://docs.gusto.com/app-integrations/reference/get-v1-salary_estimates-id.md): Retrieve a salary estimate by its UUID. Returns the estimated salary calculation along with all occupation details, revenue, and location information. scope: `salary_estimates:read` - [Update a salary estimate](https://docs.gusto.com/app-integrations/reference/put-v1-salary_estimates-id.md): Update an existing salary estimate. You can modify the annual net revenue, ZIP code, and occupations. The salary estimate must not be finalized (accepted). Once accepted, salary estimates become… - [Accept a salary estimate](https://docs.gusto.com/app-integrations/reference/post-v1-salary_estimates-uuid-accept.md): Accept and finalize a salary estimate. This associates the estimate with an employee job and marks it as accepted. Once accepted, the salary estimate becomes read-only for record-keeping purposes.… - [Search for BLS occupations](https://docs.gusto.com/app-integrations/reference/get-v1-salary_estimates-occupations.md): Search for Bureau of Labor Statistics (BLS) occupations by name or keyword. This endpoint helps users find the appropriate occupation codes to use when creating or updating salary estimates. Returns… - [Get recurring reimbursements for an employee](https://docs.gusto.com/app-integrations/reference/get-v1-employees-employee_id-recurring_reimbursements.md): Get all active recurring reimbursements for an employee. scope: `reimbursements:read` - [Create a recurring reimbursement](https://docs.gusto.com/app-integrations/reference/post-v1-employees-employee_id-recurring_reimbursements.md): Create a recurring reimbursement for an employee. scope: `reimbursements:write` - [Get a recurring reimbursement](https://docs.gusto.com/app-integrations/reference/get-v1-recurring_reimbursements.md): Get a specific recurring reimbursement. scope: `reimbursements:read` - [Update a recurring reimbursement](https://docs.gusto.com/app-integrations/reference/put-v1-recurring_reimbursements.md): Update a recurring reimbursement. scope: `reimbursements:write` - [Delete a recurring reimbursement](https://docs.gusto.com/app-integrations/reference/delete-v1-recurring_reimbursements.md): Delete (soft delete) a recurring reimbursement for an employee. scope: `reimbursements:write` ## API Reference: 1099 Contractors - [Get contractor payments for a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-contractor_payments.md): Returns an object containing individual contractor payments, within a given time period, including totals. Results are returned in reverse chronological order (newest first). scope: `payrolls:read` - [Get a single contractor payment](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_id-contractor_payment-contractor-payment.md): Returns a single contractor payment. scope: `payrolls:read` - [Create a contractor](https://docs.gusto.com/app-integrations/reference/post-v1-companies-company_uuid-contractors.md): Create an individual or business contractor. scope: `contractors:manage` - [Get contractors of a company](https://docs.gusto.com/app-integrations/reference/get-v1-companies-company_uuid-contractors.md): Get all contractors, active and inactive, individual and business, for a company. scope: `contractors:read` - [Get a contractor](https://docs.gusto.com/app-integrations/reference/get-v1-contractors-contractor_uuid.md): Get a contractor. scope: `contractors:read` - [Update a contractor](https://docs.gusto.com/app-integrations/reference/put-v1-contractors-contractor_uuid.md): Update a contractor. > 🚧 Warning > > Watch out when changing a contractor's type (when the contractor is finished onboarding). Specifically, changing contractor type can be dangerous since Gusto… ## API Reference: Reports - [Create a general ledger report](https://docs.gusto.com/app-integrations/reference/post-payrolls-payroll_uuid-reports-general_ledger.md): Create a general ledger report for a payroll. The report can be aggregated by different dimensions such as job or department. Use the `request_uuid` in the response with the [report GET… - [Get a report](https://docs.gusto.com/app-integrations/reference/get-reports-request_uuid.md): Get a company's report given the `request_uuid`. The response will include the report request's status and, if complete, the report URL. Reports containing PHI are inaccessible with… ## API Reference: Webhooks - [Create a webhook subscription](https://docs.gusto.com/app-integrations/reference/post-v1-webhook-subscription.md): Create a webhook subscription to receive events of the specified subscription_types whenever there is a state change. 📘 System Access Authentication This endpoint uses the [Bearer Auth scheme with… - [List webhook subscriptions](https://docs.gusto.com/app-integrations/reference/get-v1-webhook-subscriptions.md): Returns all webhook subscriptions associated with the provided Partner API token. 📘 System Access Authentication This endpoint uses the [Bearer Auth scheme with the system-level access token in the… - [Update a webhook subscription](https://docs.gusto.com/app-integrations/reference/put-v1-webhook-subscription-uuid.md): Updates the Webhook Subscription associated with the provided UUID. 📘 System Access Authentication This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP… - [Get a webhook subscription](https://docs.gusto.com/app-integrations/reference/get-v1-webhook-subscription-uuid.md): Returns the Webhook Subscription associated with the provided UUID. 📘 System Access Authentication This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP… - [Delete a webhook subscription](https://docs.gusto.com/app-integrations/reference/delete-v1-webhook-subscription-uuid.md): Deletes the Webhook Subscription associated with the provided UUID. 📘 System Access Authentication This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP… - [Verify a webhook subscription](https://docs.gusto.com/app-integrations/reference/put-v1-verify-webhook-subscription-uuid.md): When a webhook subscription is created, a `verification_token` is POSTed to the registered webhook subscription URL. This `verify` endpoint needs to be called with `verification_token` before webhook… - [Request a verification token for a webhook subscription](https://docs.gusto.com/app-integrations/reference/get-v1-webhook-subscription-verification-token-uuid.md): Request that the webhook subscription `verification_token` be POSTed to the Subscription URL. 📘 System Access Authentication This endpoint uses the [Bearer Auth scheme with the system-level access… - [Get the webhooks health status](https://docs.gusto.com/app-integrations/reference/get-v1-webhooks-health_check.md): Returns the health status (`healthy`, `unhealthy`, or `unknown`) of the webhooks system based on the last ten minutes of activity. 📘 System Access Authentication This endpoint uses the [Bearer Auth… - [Get all events](https://docs.gusto.com/app-integrations/reference/get-events.md): Fetch all events, going back up to 30 days, that your partner application has the required scopes for. Note that a partner does NOT have to have verified webhook subscriptions in order to utilize… ## Changelog - [August, 2026](https://docs.gusto.com/app-integrations/changelog/august-2026.md) - [July, 2026](https://docs.gusto.com/app-integrations/changelog/july-2026.md) - [June, 2026](https://docs.gusto.com/app-integrations/changelog/june-2026.md) - [v2024-04-01 Sunset](https://docs.gusto.com/app-integrations/changelog/v2024-04-01-sunset.md) - [v2026-02-01 Deprecation](https://docs.gusto.com/app-integrations/changelog/v2026-02-01-deprecation.md) - [v2026-06-15](https://docs.gusto.com/app-integrations/changelog/v2026-06-15.md) - [May, 2026](https://docs.gusto.com/app-integrations/changelog/may-2026.md) - [April, 2026](https://docs.gusto.com/app-integrations/changelog/april-2026.md) - [March, 2026](https://docs.gusto.com/app-integrations/changelog/march-2026.md) - [February, 2026](https://docs.gusto.com/app-integrations/changelog/february-2026.md)