Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Enrollments

Get enrollment details

client.enrollments.retrieve(stringenrollmentID, RequestOptionsoptions?): EnrollmentRetrieveResponse { data }
GET/v1/enrollments/{enrollment_id}

Retrieves a single enrollment: the employee and employer it belongs to, the benefit product, its status, the coverage period, the employee payroll deduction and employer contribution, and the enrolled plan’s Summary of Benefits and Coverage document when one is on file. An enrollment the caller cannot reach is indistinguishable from one that does not exist.

ParametersExpand Collapse
enrollmentID: string

Unique enrollment identifier (enrl_*)

ReturnsExpand Collapse
EnrollmentRetrieveResponse { data }

Response containing a single enrollment resource.

data: Data { id, answered_at, benefit, 11 more }

A single enrollment, including the enrolled plan’s documents.

The plan documents are resolved one enrollment at a time and are therefore not part of the list row.

id: string

Unique enrollment identifier (enrl_*)

answered_at: string | null

When the employee enrolled or waived

formatdate-time
benefit: Benefit { id, category, name, product_code }

Nested benefit product summary

id: string

Benefit product ID (bprd_*)

category: "Medical" | "Dental" | "Vision" | "Hospital"
  • Medical - Medical
  • Dental - Dental
  • Vision - Vision
  • Hospital - Hospital
One of the following:
"Medical"
"Dental"
"Vision"
"Hospital"
name: string

Display name of the benefit product

product_code: "EBA" | "VPC" | "VPC_CORE" | 12 more
  • EBA - Eba Mec
  • VPC - Vpc Enhanced
  • VPC_CORE - Vpc Core
  • MEC - Vpc Mec
  • MEC2 - Mec2
  • MEC_PLUS - Mec Plus
  • MVP - Mvp
  • MVP2 - Mvp2
  • MVPSL - Mvpsl
  • MVPSL2 - Mvpsl2
  • VD - Dental
  • VV - Vision
  • ICHRA - Ichra
  • ICHRA_PREMIUM_PLUS - Ichra Premium Plus
  • ICHRA_REIMBURSEMENT_ONLY - Ichra Reimbursement Only
One of the following:
"EBA"
"VPC"
"VPC_CORE"
"MEC"
"MEC2"
"MEC_PLUS"
"MVP"
"MVP2"
"MVPSL"
"MVPSL2"
"VD"
"VV"
"ICHRA"
"ICHRA_PREMIUM_PLUS"
"ICHRA_REIMBURSEMENT_ONLY"
coverage_end: string | null

Coverage period end date

formatdate
coverage_start: string

Coverage period start date

formatdate
created_at: string

When the enrollment was created

formatdate-time
employee_deduction_in_cents: number | null

Employee monthly payroll deduction in cents

employee_id: string

Employee ID (empl_*)

employer_contribution_in_cents: number | null

Employer monthly contribution in cents

employer_id: string

Employer ID (empr_*)

status: EnrollmentStatus
  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
One of the following:
"pending"
"enrolled"
"waived"
"inactive"
terminated_at: string | null

When coverage was terminated

formatdate-time
updated_at: string

When the enrollment was last updated

formatdate-time
sbc_url?: string | null

Summary of Benefits and Coverage (SBC) document URL for the enrolled plan; null when not on file. Only individual (ICHRA) plans carry an SBC — group plans have no SBC on record and always resolve to null.

Get enrollment details

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

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

console.log(enrollment.data);
{
  "data": {
    "id": "enrl_abc123def456",
    "employee_id": "empl_xyz789ghi012",
    "employer_id": "empr_def456ghi789",
    "benefit": {
      "id": "bprd_medical456",
      "name": "MEC Plus",
      "product_code": "MEC_PLUS",
      "category": "Medical"
    },
    "status": "enrolled",
    "coverage_start": "2026-04-01",
    "coverage_end": "2027-03-31",
    "employee_deduction_in_cents": 5000,
    "employer_contribution_in_cents": 25000,
    "answered_at": "2026-01-20T14:30:00Z",
    "terminated_at": null,
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z",
    "sbc_url": "https://carrier.example.com/documents/sbc.pdf"
  }
}
Returns Examples
{
  "data": {
    "id": "enrl_abc123def456",
    "employee_id": "empl_xyz789ghi012",
    "employer_id": "empr_def456ghi789",
    "benefit": {
      "id": "bprd_medical456",
      "name": "MEC Plus",
      "product_code": "MEC_PLUS",
      "category": "Medical"
    },
    "status": "enrolled",
    "coverage_start": "2026-04-01",
    "coverage_end": "2027-03-31",
    "employee_deduction_in_cents": 5000,
    "employer_contribution_in_cents": 25000,
    "answered_at": "2026-01-20T14:30:00Z",
    "terminated_at": null,
    "created_at": "2026-01-15T10:30:00Z",
    "updated_at": "2026-01-15T10:30:00Z",
    "sbc_url": "https://carrier.example.com/documents/sbc.pdf"
  }
}