Data available for employees and dependents
employee_id
employee_id
and group_id
group_id
. See below for filtering.id
. We provide a way to filter your employee list for a given group via query parameters. The following parameters are accepted by the API in the query string:
Object | Type | Description |
---|---|---|
date_of_birth | date | ISO-8601 date string for the date of birth of the employee to be filtered on |
first_name | string | First name of the employee to be filtered on |
last_name | string | Last name of the employee to be filtered on |
name | string | A name search for all name fields for the employee to be filtered on |
id
. We provide a way to filter your employee list via query parameters. The following parameters are accepted by the API in the query string:
Object | Type | Description |
---|---|---|
date_of_birth | date | ISO-8601 date string for the date of birth of the employee to be filtered on |
first_name | string | First name of the employee to be filtered on |
last_name | string | Last name of the employee to be filtered on |
name | string | A name search for all name fields for the employee to be filtered on |
dependent_id
, or with a dependent_id
and employee_id
combination with the Get a Single Dependent of Employee endpoint.
You can also fetch a list of dependents for a given employee using the employee’s employee_id
.
employee_id
to retrieve a list of member premiums associated with the employee and their family unit. The size of the response list will depend on the granularity of data made available by the carrier.
For example, if an employee is enrolled in dental and vision coverage and we know the exact cost split between each line of coverage, the response list would contain two member premium records, one with the dental amount
and a single billed_members
entry for the employee + dental plan, and one with the vision amount
and a single billed_members
entry for the employee + vision plan.
On the other hand, if we only know the total combined cost for both coverages, the response list would contain one member premium record with the total amount
and two billed_members
entries, one for the employee + dental plan and one for the employee + vision plan.