Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Members

List member qualifying life events

members.list_qualifying_life_events(strmember_id, MemberListQualifyingLifeEventsParams**kwargs) -> SyncPageNumberPage[MemberListQualifyingLifeEventsResponse]
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: str

Unique member identifier (mbr_*)

limit: Optional[int]

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

minimum1
maximum100
page: Optional[int]

Page number (default: 1)

minimum1
status: Optional[Literal["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: str

Opaque qualifying life event identifier

event_type: Literal["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: Optional[str]

Custom event description when event_type is Other; otherwise normally null

status: Literal["pending", "approved", "denied"]
  • pending - Pending
  • approved - Approved
  • denied - Denied
One of the following:
"pending"
"approved"
"denied"
submitted_at: datetime

When the member submitted the event

formatdate-time

List member qualifying life events

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
page = client.members.list_qualifying_life_events(
    member_id="mbr_abc123def456",
)
page = page.data[0]
print(page.id)
{
  "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
  }
}