Captures expressions of interest about an asset, collection, or product from any perspective — owner wishlists, beneficiary preferences, executor observations, proxy-relayed interests, and cross-system collector interest. Qualified by expressedByRole (who), intentType (what kind), and optionally productMatch (product-level vs asset-level). Maps to Schema.org ReactAction + Role

Required fields
idrootDocumentIdinterestLevel

Fields

FieldTypeReqDescription
assetId[string null]Reference to a specific Asset.id, if the interest is in a single asset
collectionId[string null]Reference to an AssetCollection.id, if the interest is in an entire collection
expressedAtstringWhen this interest was expressed or recorded
expressedByRoleobjectThe role of the person expressing this interest in relation to the estate or catalogue. Qualifies the authority and weight of the expression. Follows the Schema.org Role pattern testator = the estate/catalogue owner expressing a desire (directive weight). beneficiary = a named beneficiary expressing a preference. executor = an executor recording an observation or recommendation. proxy = relaying interest on behalf of another person. Extension values (x-inherit-) support additional roles such as collector interest from external systems.
idstringUnique identifier for this interest record
intentTypeobjectThe nature of the interest being expressed. Distinguishes between wanting to acquire, wanting to receive, wanting to allocate to someone, willingness to sell, and soft admiration acquire = wants to buy or obtain (collector wishlist, shopping list). receive = would like to be given or inherit (beneficiary preference). allocate = wants to give this to a specific person (testator directive). sell = willing to part with this item (signals availability). admire = appreciates the item, no action intended (soft signal).
interestLevelenumHow strongly the beneficiary has expressed interest mentioned = came up in conversation but no strong feeling. expressed_interest = person said they'd like it. strongly_wants = person has made it clear this matters to them. agreed = testator and beneficiary have informally agreed. When expressedByRole is 'testator', the levels carry directive weight: mentioned = noted as a possibility, expressed_interest = prefers this, strongly_wants = is clear about this, agreed = both parties have discussed and agreed.
notesstringAdditional context about this interest
organisationIdstringReference to the Organisation.id expressing interest, if an organisation rather than a person. Mutually exclusive with personId
organisationIdDisplaystringHuman-readable display name for the referenced organisation
personIdstringThe person expressing interest (a Person.id). The person's relationship to the estate is qualified by expressedByRole
personIdDisplaystringHuman-readable display name for the referenced person
preOrderStatusobjectFor wishlist items that have been pre-ordered from a dealer or manufacturer but not yet received. Tracks order status, payment, and expected delivery
productMatchobjectInterest in any asset matching this product identity, rather than a specific asset. Use instead of assetId when the interest is in a product class, not a specific instance. Maps to Schema.org Product (vs IndividualProduct for assetId). Matching is by identifier (strongest), brand + category (medium), or category alone (weakest)
provenanceProvenanceConsolidated provenance metadata — how this entity was created, by whom, and whether a human has verified it
quantityintegerNumber of items desired (for productMatch wishlist entries) or number of the specific asset being discussed. Default 1 if absent. Follows the same convention as asset.quantity
rootDocumentIdstringThe root document this entity belongs to — either an estate document (schema.json) or a catalogue document (catalogue.json)
sourceTypeenumHow this interest was communicated or recorded family_conversation = mentioned during a family discussion. written_request = beneficiary put it in writing. chat_message = expressed via the platform's messaging (generic). platform_private_message = private 1-to-1 message on the platform. platform_group_message = group message involving multiple parties. proxy_reported = a proxy relayed the interest on behalf of the beneficiary. testator_observed = testator noticed the person's attachment without them asking. manual = entered directly by the testator or proxy.
testatorAcknowledgedbooleanWhether the testator has seen and acknowledged this interest
mentioned
expressed_interest
strongly_wants
agreed

mentioned = came up in conversation but no strong feeling. expressed_interest = person said they'd like it. strongly_wants = person has made it clear this matters to them. agreed = testator and beneficiary have informally agreed. When expressedByRole is 'testator', the levels carry directive weight: mentioned = noted as a possibility, expressed_interest = prefers this, strongly_wants = is clear about this, agreed = both parties have discussed and agreed.

family_conversation
written_request
chat_message
platform_private_message
platform_group_message
proxy_reported
testator_observed
manual

family_conversation = mentioned during a family discussion. written_request = beneficiary put it in writing. chat_message = expressed via the platform's messaging (generic). platform_private_message = private 1-to-1 message on the platform. platform_group_message = group message involving multiple parties. proxy_reported = a proxy relayed the interest on behalf of the beneficiary. testator_observed = testator noticed the person's attachment without them asking. manual = entered directly by the testator or proxy.

Get in touch

Have feedback on the schema reference? We'd love to hear from you.

Subject: Schema Reference Feedback