site.get_visitors

Overview

Returns all visitors at the possessed character's current site with cached portraits.

Returns a JSON object with the following fields:

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

await inzoi.cli.execute('site.get_visitors');