contacts.get_all

Overview

Returns all contacts of the possessed character with blocked status and cached portraits.

Returns a JSON object with the following fields:

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

await inzoi.cli.execute('contacts.get_all');