---
title: "Get Entity Properties"
method: GET
path: "/v1/entities/{entity_id}/properties"
tags: ["entities", "product-api", "product-api"]
---

# Get Entity Properties

`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

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`.

## Path parameters

- `entity_id` string, required

## Query parameters

- `campaign_id` string, required
- `type` 'characters' | 'factions' | 'locations' | 'items', required: Entity type

## Headers

- `x-api-key` string, nullable

## Response `200`

Successful Response

- EntityPropertiesResponse
  - `entity_id` string, required
  - `entity_type` string, required
  - `compendium_entity_type` string, nullable
  - `tables` PropertyTableRead[], required
    - `table_type` string, required
    - `label` string, required
    - `fields` PropertyFieldRead[], required
      - `id` string, required
      - `key` string, required
      - `label` string, required
      - `description` string, nullable
      - `field_type` string, required
      - `is_required` boolean
      - `sort_order` integer
      - `options` string[], nullable
      - `connection_types` string[]
      - `value` unknown
      - `updated_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/myarchivist/apis/archivist-public-api.md) · [All operations](https://skmtc.dev/myarchivist/apis/archivist-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/myarchivist/apis/archivist-public-api/revisions/3ea6ca7efc56?raw)