List member dependents

members.list_dependents(member_id) -> MemberListDependentsResponse { data }

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

Unique member identifier (mbr_*)

ReturnsExpand Collapse

class MemberListDependentsResponse { data }

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

data: Array[{ age, date_of_birth, first_name, 5 more}]

age: Integer

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

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

first_name: String

Dependent’s first name

last_name: String

Dependent’s last name

member_id: String

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

primary_member_id: String

The primary member’s identifier with ‘mbr_’ prefix

relationship: :Spouse | :Child

Spouse - Spouse
Child - Child

One of the following:

:Spouse

:Child

sex_at_birth: :Male | :Female | :Other | :Unknown

Male - Male
Female - Female
Other - Other
Unknown - Unknown

One of the following:

:Male

:Female

:Other

:Unknown

List member dependents

require "vitable_connect"

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

response = vitable_connect.members.list_dependents("mbr_abc123def456")

puts(response)

{
  "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"
    }
  ]
}