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

List member dependents

members.list_dependents(strmember_id) -> MemberListDependentsResponse
GET/v1/members/{member_id}/dependents

Lists a member’s active legal dependents — name, relationship, date of birth, age, and sex at birth. Access is scoped to the authenticated principal; a member not visible to the caller returns a 404.

ParametersExpand Collapse
member_id: str

Unique member identifier (mbr_*)

ReturnsExpand Collapse
class MemberListDependentsResponse: …

Unpaginated {"data": [...]} list of member dependents.

data: List[Data]
age: int

Dependent’s age in years, derived from date of birth

date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
first_name: str

Dependent’s first name

last_name: str

Dependent’s last name

member_id: str

The dependent’s own member identifier with ‘mbr_’ prefix

primary_member_id: str

The primary member’s identifier with ‘mbr_’ prefix

relationship: Literal["Spouse", "Child"]
  • Spouse - Spouse
  • Child - Child
One of the following:
"Spouse"
"Child"
sex_at_birth: Optional[Literal["Male", "Female", "Other", "Unknown"]]
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
One of the following:
"Male"
"Female"
"Other"
"Unknown"

List member dependents

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
)
response = client.members.list_dependents(
    "mbr_abc123def456",
)
print(response.data)
{
  "data": [
    {
      "name": "Sam Doe",
      "relationship": "Child",
      "date_of_birth": "2015-06-01",
      "age": 11,
      "sex_at_birth": "Male"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "name": "Sam Doe",
      "relationship": "Child",
      "date_of_birth": "2015-06-01",
      "age": 11,
      "sex_at_birth": "Male"
    }
  ]
}