Tag
/api/v1/common/tagsA free-form tag attachable to any entity.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| name | string | Canonical machine-friendly name of the tag. Must be lowercase kebab-case (e.g. 'soc2-in-scope', 'pii-data', 'critical-asset'). This is the value stored on tagge |
| display_name | string | Human-readable label displayed in the UI for this tag. |
| color | string | Hex color code for rendering this tag as a colored chip in the UI. Must be a 6-digit hex color prefixed with '#'. Null for tags with no assigned color. |
| description | string | Optional description explaining the purpose and intended usage of this tag. |
| created_by_id | uuid | UUID of the Person who created this tag. |
API
Loading manifest…