v1
latestOpenAPI 3.1.02026-07-243113441.2 MBCompany Benefits
Get company benefit summary by company benefit id.
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/v1/company_benefits/{company_benefit_id}/summary
Path parameters
company_benefit_idstring required
The UUID of the company benefit
Query parameters
start_datestring
The start date for which to retrieve company benefit summary
end_datestring
The end date for which to retrieve company benefit summary. If left empty, defaults to today's date.
detailedboolean
Display employee payroll item summary
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
Benefit summary response