Get an employee benefit
GET {{baseUrl}}/v1/employee_benefits/:employee_benefit_id
Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.
Benefits containing PHI are only visible to applications with the employee_benefits:read:phi
scope.
scope: employee_benefits:read
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
{"version":"09j3d29jqdpj92109j9j2d90dq","employee_uuid":908123091820398,"company_benefit_uuid":"54e37c27-43e6-4ae5-a5b2-e29895a133be","active":true,"uuid":"e91ca856-a915-4339-9b18-29f9cd66b031","employee_deduction":"100.00","employee_deduction_annual_maximum":"200.00","company_contribution_annual_maximum":"200.00","limit_option":null,"deduct_as_percentage":false,"catch_up":false,"coverage_amount":null,"deduction_reduces_taxable_income":null,"coverage_salary_multiplier":"0.00","contribution":{"type":"amount","value":"100.00"}}