entities
product-api
product-api

Get Entity Properties

Property tables (Identity / Connections / General) for one compendium entity.

Product-view only for now (not yet documented/tested for other views).

Field definitions are per-campaign and per-entity-type; values are per-entity. Fields with no stored value are returned with value: null.

get/v1/entities/{entity_id}/properties

Request

  • Base URL: https://api.myarchivist.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.myarchivist.ai/v1/entities/{entity_id}/properties
  • Auth: HTTP bearer

Path parameters

entity_idstring required

Query parameters

campaign_idstring required
type'characters' | 'factions' | 'locations' | 'items' required

Entity type

Headers

x-api-keystring nullable

Response

Successful Response

entity_idstring required
entity_typestring required
compendium_entity_typestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.