List member qualifying life events

members.list_qualifying_life_events(member_id, **kwargs) -> PageNumberPage<MemberListQualifyingLifeEventsResponse { id, event_type, other_event, 2 more } >

GET/v1/members/{member_id}/qualifying-life-events

Lists a member’s qualifying life events, including events already used for another enrollment. Returns all statuses by default; pass the status query param to filter to one (e.g. approved). Events are ordered newest submission first with stable paging. Custom text is present only when submitted and is otherwise null. A member not visible to the caller returns a 404. API keys and unbound access tokens have organization-wide access. Employer-bound tokens require employment at the bound employer, and employee-bound tokens require the exact employee-member relationship. Organization or scope mismatches return a 404 before pagination is validated.

ParametersExpand Collapse

member_id: String

Unique member identifier (mbr_*)

limit: Integer

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

minimum1

maximum100

page: Integer

Page number (default: 1)

minimum1

status: :approved | :denied | :pending

Optional. Filter to a single QLE status; omit to return all statuses.

One of the following:

:approved

:denied

:pending

ReturnsExpand Collapse

class MemberListQualifyingLifeEventsResponse { id, event_type, other_event, 2 more }

id: String

Opaque qualifying life event identifier

event_type: :Married | :Divorced | :"New child" | 2 more

Married - Married
Divorced - Divorced
New child - New Child
Court ordered - Court Ordered
Other - Other

One of the following:

:Married

:Divorced

:"New child"

:"Court ordered"

:Other

other_event: String

Custom event description when event_type is Other; otherwise normally null

status: :pending | :approved | :denied

pending - Pending
approved - Approved
denied - Denied

One of the following:

:pending

:approved

:denied

submitted_at: Time

When the member submitted the event

formatdate-time

List member qualifying life events

require "vitable_connect"

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

page = vitable_connect.members.list_qualifying_life_events("mbr_abc123def456")

puts(page)

{
  "data": [
    {
      "id": "qle_AAAAAAAAAAAAAAAAAAAAAQ",
      "event_type": "Other",
      "other_event": "Relocation",
      "status": "approved",
      "submitted_at": "2026-07-01T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}

Returns Examples

{
  "data": [
    {
      "id": "qle_AAAAAAAAAAAAAAAAAAAAAQ",
      "event_type": "Other",
      "other_event": "Relocation",
      "status": "approved",
      "submitted_at": "2026-07-01T14:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}