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
Request
- Base URLhttps://api.gusto-demo.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The UUID of the company benefit
Query parameters
Whether to return employee benefits associated with the benefit
Available options:
- all_benefits: If with_employee_benefits=true, include all effective dated benefits for each employee instead of only the current benefits.
Headers
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
Changes
No recorded changes to this operation across all 2 revisions of this API.