Get a company benefit
GET {{baseUrl}}/v1/company_benefits/:company_benefit_id?with_employee_benefits=<boolean>
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 withemployeebenefits parameter with true value is passed, employeebenefits:read scope is required to return employeebenefits.
scope: company_benefits:read
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
with_employee_benefits | string | Whether to return employee benefits associated with the benefit |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Gusto-API-Version | string | Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used. | |
Accept | string |
RESPONSES
status: OK
{"uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","version":"98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872","active":true,"description":"Kaiser Permanente","deletable":true,"supports_percentage_amounts":true,"responsible_for_employer_taxes":false,"responsible_for_employee_w2":false,"employee_benefits":[{"employee_uuid":"ae44a0b2-3c89-41e1-91c8-5f8224a779ca","company_benefit_uuid":"d2cec746-caee-464a-bcaf-00d93f7049c9","active":true,"deduct_as_percentage":false,"employee_deduction":3,"company_contribution":0,"uuid":"9988f241-9aee-4383-bfca-eac79cf58135","contribution":{"type":"amount","value":0}}]}