Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Qualifying Life Events

Get qualifying life event details

client.qualifyingLifeEvents.retrieve(stringqleID, RequestOptionsoptions?): QualifyingLifeEvent { id, created_at, employee_id, 10 more }
get/v1/qualifying-life-events/{qle_id}

Retrieves detailed information for a specific QLE by ID. Returns event type, date, status, and enrollment window information.

ParametersExpand Collapse
qleID: string
ReturnsExpand Collapse
QualifyingLifeEvent { id, created_at, employee_id, 10 more }

Serializer for Qualifying Life Event entity in public API responses.

QLEs are significant life changes (marriage, birth, adoption, loss of coverage) that allow employees to modify benefit elections outside of open enrollment.

id: string

Unique QLE identifier with 'qle_' prefix

created_at: string

Timestamp when the QLE was created

formatdate-time
employee_id: string

ID of the employee (empl_*)

enrollment_window_end: string

End of the special enrollment period (typically 30-60 days from event)

formatdate
enrollment_window_start: string

Start of the special enrollment period

formatdate
event_date: string

Date when the qualifying life event occurred

formatdate
event_type: string

Type of qualifying life event (e.g., 'marriage', 'birth', 'adoption', 'loss_of_coverage', 'divorce')

member_id: string

ID of the member experiencing the life event (mbr_*)

status: QualifyingLifeEventStatus
  • pending - Pending
  • approved - Approved
  • denied - Denied
Accepts one of the following:
"pending"
"approved"
"denied"
updated_at: string

Timestamp when the QLE was last updated

formatdate-time
notes?: string | null

Additional notes or comments about the QLE

reviewed_at?: string | null

Timestamp when the QLE was reviewed, if reviewed

formatdate-time
reviewed_by?: string | null

ID of the user who reviewed the QLE, if reviewed

Get qualifying life event details
import VitableConnectAPI from 'vitable-connect-api';

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

const qualifyingLifeEvent = await client.qualifyingLifeEvents.retrieve('qle_abc123def456');

console.log(qualifyingLifeEvent.id);
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "employee_id": "employee_id",
  "enrollment_window_end": "2019-12-27",
  "enrollment_window_start": "2019-12-27",
  "event_date": "2019-12-27",
  "event_type": "event_type",
  "member_id": "member_id",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "notes": "notes",
  "reviewed_at": "2019-12-27T18:11:19.117Z",
  "reviewed_by": "reviewed_by"
}
Returns Examples
{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "employee_id": "employee_id",
  "enrollment_window_end": "2019-12-27",
  "enrollment_window_start": "2019-12-27",
  "event_date": "2019-12-27",
  "event_type": "event_type",
  "member_id": "member_id",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "notes": "notes",
  "reviewed_at": "2019-12-27T18:11:19.117Z",
  "reviewed_by": "reviewed_by"
}