List Household Entities
list_household_entitiesList the household's structured entities, trusts, properties, assets, and personal filing bucket with stable IDs, lifecycle state, aliases, and optional document/artifact counts. When members list their own household without a status filter, the result includes current items and items they added themselves; self-added items remain clearly labeled, not source-backed, and non-fileable until X1 matches supporting evidence. Explicit current filters and professional lookups remain source-backed only. Members and assigned Multiplier operators can use valid fileable IDs for filing and cleanup; advisors can use them to understand the client's household map and file professional artifacts under existing confirmed items. Non-fileable entities cannot be used as belongs-to targets for filing or saved artifacts. Scoped specialists are excluded from this broad household graph surface.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| status | No | Entity lifecycle filter. When omitted, members see their confirmed household items plus items they added themselves; an explicit current filter returns only confirmed items. In both, items X1 identified in documents but nobody has confirmed are listed separately under identifiedForReview and never counted as household items. all, former and member_asserted return those rows as stored. | |
| clientId | No | Client or member user ID. Members usually omit this. | |
| clientRef | No | The member's name or email when you do not know clientId. Household changes need their exact full name or email. | |
| entityType | No | ||
| includeCounts | No |