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

List member's qualifying life events

members.qualifying_life_events.list(member_id, **kwargs) -> QualifyingLifeEventListResponse { id, created_at, employee_id, 10 more }
get/v1/members/{member_id}/qualifying-life-events

Retrieves a paginated list of qualifying life events for a member. QLEs are significant life changes (marriage, birth, adoption, loss of coverage) that allow benefit enrollment changes outside open enrollment.

ParametersExpand Collapse
member_id: String
event_type: EventType

Filter by QLE type

Accepts one of the following:
:Marriage
:Birth
:Adoption
:Divorce
:Death
:"Job Loss"
:"Reduction In Hours"
:"Employer Bankruptcy"
:"Medicare Entitlement"
:Termination
:Other
limit: Integer

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

minimum1
maximum100
page: Integer

Page number (default: 1)

minimum1
status: QualifyingLifeEventStatus

Filter by QLE status

Accepts one of the following:
:pending
:approved
:denied
ReturnsExpand Collapse
Array[QualifyingLifeEvent { id, created_at, employee_id, 10 more } ]
id: String

Unique QLE identifier with 'qle_' prefix

created_at: Time

Timestamp when the QLE was created

formatdate-time
employee_id: String

ID of the employee (empl_*)

enrollment_window_end: Date

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

formatdate
enrollment_window_start: Date

Start of the special enrollment period

formatdate
event_date: Date

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: Time

Timestamp when the QLE was last updated

formatdate-time
notes: String

Additional notes or comments about the QLE

reviewed_at: Time

Timestamp when the QLE was reviewed, if reviewed

formatdate-time
reviewed_by: String

ID of the user who reviewed the QLE, if reviewed

List member's qualifying life events
require "vitable_connect_api"

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

qualifying_life_events = vitable_connect_api.members.qualifying_life_events.list("mbr_abc123def456")

puts(qualifying_life_events)
[
  {
    "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"
  }
]