v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Benefits
Public API

List Member Benefits

Returns a paginated list of benefit enrollment records for all members (employees and dependents) in the company for a given calendar year. Each record represents one member and includes the plans they held and the date ranges during which they held each enrollment status. Dependents appear alongside their subscribing employee via subscriberId. Use "List Company Benefits" to get valid planId values.

OAuth Scopes: benefit

get/api/v1/benefits/member-benefits

Query parameters

calendarYearstring required
Example:2024

The 4-digit calendar year (YYYY) to retrieve benefit enrollment data for.

pagestring
Example:1

The 1-based page number for pagination. The value is cast to an integer; values that cast to 0 or below are rejected with a 400. Defaults to 1.

pageSizestring
Example:25

The number of items per page. The value is cast to an integer; values that cast to 0 or below, or to 100 or above, are rejected with a 400. Defaults to 25.

Response

A paginated list of member benefit enrollment records for the requested calendar year.