GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Get company benefit summary by company benefit id.

get
https://api.gusto-demo.com/v1/company_benefits//summary

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

Path Params
string
required

The UUID of the company benefit

Query Params
string

The start date for which to retrieve company benefit summary

string

The end date for which to retrieve company benefit summary. If left empty, defaults to today's date.

boolean

Display employee payroll item summary

Headers
string
enum
Defaults to 2026-02-01

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

Allowed:
Responses

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago