Skip to content

List employee enrollments

employees.list_enrollments(employee_id, **kwargs) -> PageNumberPage<Enrollment { id, answered_at, benefit, 10 more } >
GET/v1/employees/{employee_id}/enrollments

Retrieves a paginated list of benefit enrollments for an employee.

ParametersExpand Collapse
employee_id: String

Unique employee identifier (empl_*)

limit: Integer

Items per page (default: 20, max: 100)

minimum1
maximum100
page: Integer

Page number (default: 1)

minimum1
ReturnsExpand Collapse
class Enrollment { id, answered_at, benefit, 10 more }
id: String

Unique enrollment identifier (enrl_*)

answered_at: Time

When the employee enrolled or waived

formatdate-time
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: Date

Coverage period end date

formatdate
coverage_start: Date

Coverage period start date

formatdate
created_at: Time

When the enrollment was created

formatdate-time
employee_deduction_in_cents: Integer

Employee monthly payroll deduction in cents

employee_id: String

Employee ID (empl_*)

employer_contribution_in_cents: Integer

Employer monthly contribution in cents

employer_id: String

Employer ID (empr_*)

  • pending - Pending
  • enrolled - Enrolled
  • waived - Waived
  • inactive - Inactive
One of the following:
:pending
:enrolled
:waived
:inactive
terminated_at: Time

When coverage was terminated

formatdate-time
updated_at: Time

When the enrollment was last updated

formatdate-time

List employee enrollments

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

page = vitable_connect.employees.list_enrollments("empl_abc123def456")

puts(page)
{
  "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"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}
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"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}