Skip to content
Vitable Docs Vitable Docs Vitable Docs
Get started
API Reference
Members
Dependents

List member dependents

members.dependents.list(strmember_id, DependentListParams**kwargs) -> DependentListResponse
get/v1/members/{member_id}/dependents

Retrieves a paginated list of dependents for a specific member. Dependents include spouses, children, and domestic partners who may be eligible for benefit coverage.

ParametersExpand Collapse
member_id: str
active_in: Optional[bool]

Filter by active status

limit: Optional[int]

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

minimum1
maximum100
page: Optional[int]

Page number (default: 1)

minimum1
relationship: Optional[Relationship]

Filter by relationship type

Accepts one of the following:
"Spouse"
"Child"
ReturnsExpand Collapse
DependentListResponse = List[Dependent]
id: str

Unique dependent identifier with 'dpnd_' prefix

active: bool

Whether the dependent is currently active

created_at: datetime

Timestamp when the dependent was created

formatdate-time
date_of_birth: date

Dependent's date of birth (YYYY-MM-DD)

formatdate
first_name: str

Dependent's legal first name

last_name: str

Dependent's legal last name

member_id: str

ID of the primary member/employee (mbr_*)

relationship: Relationship
  • Spouse - Spouse
  • Child - Child
Accepts one of the following:
"Spouse"
"Child"
sex: Sex
  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown
Accepts one of the following:
"Male"
"Female"
"Other"
"Unknown"
updated_at: datetime

Timestamp when the dependent was last updated

formatdate-time
gender: Optional[str]

Gender identity, if provided

ssn_last_four: Optional[str]

Last 4 digits of SSN (masked)

suffix: Optional[str]

Name suffix (e.g., Jr., Sr., III)

List member dependents
from vitable_connect_api import VitableConnectAPI

client = VitableConnectAPI(
    api_key="My API Key",
)
dependents = client.members.dependents.list(
    member_id="mbr_abc123def456",
)
print(dependents)
[
  {
    "id": "id",
    "active": true,
    "created_at": "2019-12-27T18:11:19.117Z",
    "date_of_birth": "2019-12-27",
    "first_name": "first_name",
    "last_name": "last_name",
    "member_id": "member_id",
    "relationship": "Spouse",
    "sex": "Male",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "gender": "gender",
    "ssn_last_four": "ssn_last_four",
    "suffix": "suffix"
  }
]
Returns Examples
[
  {
    "id": "id",
    "active": true,
    "created_at": "2019-12-27T18:11:19.117Z",
    "date_of_birth": "2019-12-27",
    "first_name": "first_name",
    "last_name": "last_name",
    "member_id": "member_id",
    "relationship": "Spouse",
    "sex": "Male",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "gender": "gender",
    "ssn_last_four": "ssn_last_four",
    "suffix": "suffix"
  }
]