Get enrollment details

client.enrollments.retrieve(, ?): Enrollment { id, benefit_product_id, created_at, 13 more }

get/v1/enrollments/{enrollment_id}

Retrieves detailed information for a specific enrollment by ID. Returns selected plan, coverage dates, enrolled dependents, premium amounts, and status. This endpoint is critical for viewing comprehensive enrollment information.

ParametersExpand Collapse

enrollmentID: string

ReturnsExpand Collapse

Enrollment { id, benefit_product_id, created_at, 13 more }

Serializer for Enrollment entity in public API responses.

An Enrollment represents an employee's benefit enrollment for a specific plan year.

id: string

Unique enrollment identifier with 'enrl_' prefix

benefit_product_id: string

ID of the benefit product (bprd_*)

created_at: string

Timestamp when the enrollment was created

formatdate-time

employee_id: string

ID of the employee (empl_*)

plan_year_id: string

ID of the plan year (plyr_*)

status: EnrollmentStatus

pending - Pending
enrolled - Enrolled
waived - Waived
inactive - Inactive

Accepts one of the following:

"pending"

"enrolled"

"waived"

"inactive"

updated_at: string

Timestamp when the enrollment was last updated

formatdate-time

coverage_end_date?: string | null

Date when coverage ends

formatdate

coverage_start_date?: string | null

Date when coverage begins

formatdate

coverage_tier?: CoverageTier | null

Unspecified - Unspecified
EE - Ee
ES - Es
EC - Ec
EF - Ef

Accepts one of the following:

"Unspecified"

"EE"

"ES"

"EC"

"EF"

decision?: string | null

Employee's election decision: 'enrolled' (accepted) or 'waived' (declined)

employee_contribution_cents?: number | null

Employee's monthly contribution in cents

employer_contribution_cents?: number | null

Employer's monthly contribution in cents

enrolled_dependents?: Array<EnrolledDependent>

List of dependents included in this enrollment

dependent_id: string

ID of the dependent (dpnd_*)

first_name: string

Dependent's first name

last_name: string

Dependent's last name

relationship: Relationship

Spouse - Spouse
Child - Child

Accepts one of the following:

"Spouse"

"Child"

selected_plan_id?: string | null

ID of the selected plan (plan_*), if enrolled

selected_plan_name?: string | null

Name of the selected plan

Get enrollment details

import VitableConnectAPI from 'vitable-connect-api';

const client = new VitableConnectAPI({
  apiKey: 'My API Key',
});

const enrollment = await client.enrollments.retrieve('enrl_abc123def456');

console.log(enrollment.id);

{
  "id": "id",
  "benefit_product_id": "benefit_product_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "employee_id": "employee_id",
  "plan_year_id": "plan_year_id",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "coverage_end_date": "2019-12-27",
  "coverage_start_date": "2019-12-27",
  "coverage_tier": "Unspecified",
  "decision": "decision",
  "employee_contribution_cents": 0,
  "employer_contribution_cents": 0,
  "enrolled_dependents": [
    {
      "dependent_id": "dependent_id",
      "first_name": "first_name",
      "last_name": "last_name",
      "relationship": "Spouse"
    }
  ],
  "selected_plan_id": "selected_plan_id",
  "selected_plan_name": "selected_plan_name"
}

Returns Examples

{
  "id": "id",
  "benefit_product_id": "benefit_product_id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "employee_id": "employee_id",
  "plan_year_id": "plan_year_id",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "coverage_end_date": "2019-12-27",
  "coverage_start_date": "2019-12-27",
  "coverage_tier": "Unspecified",
  "decision": "decision",
  "employee_contribution_cents": 0,
  "employer_contribution_cents": 0,
  "enrolled_dependents": [
    {
      "dependent_id": "dependent_id",
      "first_name": "first_name",
      "last_name": "last_name",
      "relationship": "Spouse"
    }
  ],
  "selected_plan_id": "selected_plan_id",
  "selected_plan_name": "selected_plan_name"
}