v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Company Benefits

Get a company benefit

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.

scope: company_benefits:read

get/v1/company_benefits/{company_benefit_id}

Path parameters

company_benefit_idstring required

The UUID of the company benefit

Query parameters

with_employee_benefitsboolean

Whether to return employee benefits associated with the benefit

include'all_benefits'

Available options:

all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Success

versionstring

The current version of the object. See the versioning guide for information on how to use this field.

company_uuidstring

The UUID of the company.

uuidstring required

The UUID of the company benefit.

benefit_typeinteger

The type of the benefit to which the company benefit belongs (same as benefit_id).

activeboolean

Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating.

descriptionstring

The description of the company benefit. For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.

source'internal' | 'external' | 'partnered'

The source of the company benefit. This can be "internal", "external", or "partnered". Company benefits created via the API default to "external". Certain partners can create company benefits with a source of "partnered".

partner_namestring nullable

The partner name of the partner that created the company benefit. For example, "XYZ Corp".

deletableboolean

Whether this company benefit can be deleted. Deletable will be set to true if the benefit has not been used in payroll, has no employee benefits associated, and the benefit is not owned by Gusto or a Partner

supports_percentage_amountsboolean

Whether employee deductions and company contributions can be set as percentages of payroll for an individual employee. This is determined by the type of benefit and is not configurable by the company.

responsible_for_employer_taxesboolean

Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits.

responsible_for_employee_w2boolean

Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to third party sick pay benefits.

catch_up_type'elective' | 'deemed' nullable

The type of catch-up contribution for this benefit, as required by Section 603 of the SECURE 2.0 Act. Only applicable to pre-tax 401(k) and 403(b) benefits.