Sign in
Plan

beneficiaries

Returns all beneficiaries for a given plan.<p>Scopes: export_enrollment</p>

get/v{version}/plans/{plan_id}/beneficiaries

Path parameters

plan_idstring required

The plan that the beneficiaries are on.

versionstring required

Query parameters

employee_idstring

The employee to filter by. Optional.

typestring

The beneficiary type to filter by (must be either 'Primary', 'Secondary', or 'Tertiary'). Optional.

start_idstring

The id to start fetching from. Optional.

limitinteger

Limits the number of records returned. Optional. The default is 50.

Response

Success

next_idstring

The id of the object next up after this set.

errorstring

Contains any error messages, if applicable.

Example response

{
  "data": [
    {
      "birth_date": "yyyy-MM-dd"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.