Overview

Retrieve smart tags for categorizing and labeling entities

Overview

Smart tags are customizable labels that can be applied to entities within the system. They provide a flexible way to categorize, filter, and organize data according to your business needs.

Each smart tag includes:

• tagName: A unique identifier for the tag (used programmatically)
• tagDisplayName: A human-readable display name
• tagDescription: Optional description explaining the tag’s purpose
• tagCategories: Array of category strings for grouping related tags
• tagData: Flexible JSON object for storing additional metadata

Use Cases

Smart tags can be used to:

• Categorize policies by coverage type or risk profile
• Label insureds by segment or acquisition channel
• Mark events by severity or handling priority
• Group entities for reporting and analytics

Permissions

• Read: Requires company:read permission

Example Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "tagName": "high_value_account",
      "tagDisplayName": "High Value Account",
      "tagDescription": "Accounts with annual premium over $100k",
      "tagCategories": ["account_tier", "priority"],
      "tagData": {
        "type": "account_classification"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ],
  "totalCount": 1
}