Get member household

members.retrieve_household(member_id) -> MemberRetrieveHouseholdResponse { data }

GET/v1/members/{member_id}/household

Lists a member’s household as a per-participant table — the account holder plus each active household member, with name, relationship, member type, date of birth, and household-admin flag. Access is scoped to the authenticated principal; a member not visible to the caller (or with no household) returns a 404.

ParametersExpand Collapse

member_id: String

Unique member identifier (mbr_*)

ReturnsExpand Collapse

class MemberRetrieveHouseholdResponse { data }

Unpaginated {"data": [...]} list of the members of a member’s household.

data: Array[{ date_of_birth, first_name, household_admin_in, 4 more}]

date_of_birth: Date

Date of birth (YYYY-MM-DD)

formatdate

first_name: String

Household member’s first name

household_admin_in: bool

Whether this participant is a household admin (the account holder always is)

last_name: String

Household member’s last name

member_id: String

Member identifier with ‘mbr_’ prefix

member_type: :"Account Holder" | :Dependent | :Inactive

Account Holder - Account Holder
Dependent - Dependent
Inactive - Inactive

One of the following:

:"Account Holder"

:Dependent

:Inactive

relationship: :Child | :Spouse | :Roommate | :Other

Child - Child
Spouse - Spouse
Roommate - Roommate
Other - Other

One of the following:

:Child

:Spouse

:Roommate

:Other

Get member household

require "vitable_connect"

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

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

puts(response)

{
  "data": [
    {
      "member_id": "mbr_abc123def456",
      "name": "Jane Doe",
      "relationship": null,
      "member_type": "Account Holder",
      "date_of_birth": "1990-04-12",
      "household_admin_in": true
    },
    {
      "member_id": "mbr_def456abc789",
      "name": "John Doe",
      "relationship": "Spouse",
      "member_type": "Household Dependent",
      "date_of_birth": "1989-02-03",
      "household_admin_in": false
    }
  ]
}

Returns Examples

{
  "data": [
    {
      "member_id": "mbr_abc123def456",
      "name": "Jane Doe",
      "relationship": null,
      "member_type": "Account Holder",
      "date_of_birth": "1990-04-12",
      "household_admin_in": true
    },
    {
      "member_id": "mbr_def456abc789",
      "name": "John Doe",
      "relationship": "Spouse",
      "member_type": "Household Dependent",
      "date_of_birth": "1989-02-03",
      "household_admin_in": false
    }
  ]
}