DocumentTag

Tag for categorizing and searching documents and content. Extends Tag with document-specific properties.

Extends: Tag
19 properties
Schema

Properties

Includes inherited properties from Tag

PropertyTypeModeDescriptionRequiredSource
namestring
stored

Name or label of the tag

Example: "VIP"

Required
Tag
slugstring
stored

URL-friendly version of the tag name for routing and APIs

Example: "vip"

Optional
Tag
categorystring
stored

Category or group for the tag (e.g., 'segment', 'industry', 'priority', 'status')

Example: "segment"

Optional
Tag
descriptionstring
stored

Detailed description of what this tag represents

Example: "Very Important Person - top tier customer"

Optional
Tag
colorstring
stored

Color code for visual representation in UI (hex color)

Example: "#8B5CF6"

Optional
Tag
iconstring
stored

Optional icon identifier for the tag

Example: "star"

Optional
Tag
isActiveboolean
stored

Whether this tag is currently active and available for assignment

Example: true

Optional
Tag
sortOrdernumber
stored

Display order for sorting tags in UI

Example: 1

Optional
Tag
documentDocument
stored

Reference to the document being tagged

Required
DocumentTag
assignedAtDateTime
stored

Timestamp when the tag was assigned to this document

Example: "2024-11-12T10:00:00Z"

Required
DocumentTag
assignedByUser
stored

User who assigned the tag to this document

Optional
DocumentTag