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

Get member household

members.retrieve_household(strmember_id) -> MemberRetrieveHouseholdResponse
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: str

Unique member identifier (mbr_*)

ReturnsExpand Collapse
class MemberRetrieveHouseholdResponse: …

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

data: List[Data]
date_of_birth: date

Date of birth (YYYY-MM-DD)

formatdate
first_name: str

Household member’s first name

household_admin_in: bool

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

last_name: str

Household member’s last name

member_id: str

Member identifier with ‘mbr_’ prefix

member_type: Literal["Account Holder", "Dependent", "Inactive"]
  • Account Holder - Account Holder
  • Dependent - Dependent
  • Inactive - Inactive
One of the following:
"Account Holder"
"Dependent"
"Inactive"
relationship: Optional[Literal["Child", "Spouse", "Roommate", "Other"]]
  • Child - Child
  • Spouse - Spouse
  • Roommate - Roommate
  • Other - Other
One of the following:
"Child"
"Spouse"
"Roommate"
"Other"

Get member household

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.retrieve_household(
    "mbr_abc123def456",
)
print(response.data)
{
  "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
    }
  ]
}