household.get_members

Overview

Returns all members of a household. If household_id is omitted, uses the possessed character's household.

Name	Type	Required	Default	Description
household_id	entityId	no	—	Target household entity ID (default: possessed character's household)

Returns a JSON object with the following fields:

Field	Type	Required	Description
`household_id`	entityId	yes	Household entity id
`name`	string	yes	Household display name
`members`	array	yes	Household members
`members[].entity_id`	entityId	yes	Member entity id
`members[].first_name`	string	yes	First name
`members[].last_name`	string	yes	Last name
`members[].household_id`	entityId	no	Member's household id
`members[].gender`	string	no	Gender enum name
`members[].age_group`	string	no	Age group enum name
`members[].gender_text`	string	no	Localized gender
`members[].age_group_text`	string	no	Localized age group
`members[].current_site`	string	no	Current site name
`members[].portrait_url`	string	no	Cached portrait URL
`members[].is_married`	bool	no	Whether married
`members[].spouse_id`	entityId	no	Spouse entity id (if married)
`members[].has_career`	bool	yes	Has any career
`members[].employable`	bool	yes	Eligible for new employment
`members[].job_name`	string	no	Localized job name
`members[].job_rank`	int	no	Job rank
`members[].job_rank_name`	string	no	Localized job rank name
`members[].relationship_label`	string	no	Relationship label toward the possessed character

await inzoi.cli.execute('household.get_members', {
  household_id: 0, // optional
});