List Employee Benefits

Returns current and future benefit enrollment records for one or more employees, grouped by employee. A JSON request body with a filters object is required; at least one filter field must be provided. Results are grouped per employee with pay frequency and an array of per-plan records including enrollment status, deduction amounts, and employer/employee cost-sharing details. Use List Company Benefits to get valid companyBenefitId values.

Body Params

Filters to scope the results. The filters object is required and must include at least one filter field.

filters
required

Scope filters for the request. At least one of employeeId, companyBenefitId, or enrollmentStatusEffectiveDate must be provided; omitting all three returns a 400 validation error.

Responses

400

Bad request. The request body is missing, is not valid JSON, or the filters object is missing or invalid.

401

Unauthorized. Invalid or missing authentication credentials.

403

Forbidden. The authenticated user does not have access to benefit data.

500

Internal server error.

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