GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Get a company benefit

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

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

Path Params
string
required

The UUID of the company benefit

Query Params
boolean

Whether to return employee benefits associated with the benefit

string
enum

Available options:

  • all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
Allowed:
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