Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
smart-tags
List Smart Tags
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/smart-tags \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440300",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "tagName": "policyPremium",
      "tagDisplayName": "Policy Premium",
      "tagDescription": "Total premium amount for the policy",
      "tagCategories": [
        "policy",
        "quote"
      ],
      "tagData": {
        "type": "text"
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-20T14:00:00.000Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440301",
      "companyId": "550e8400-e29b-41d4-a716-446655440000",
      "tagName": "generalLiabilityPremium",
      "tagDisplayName": "General Liability Premium",
      "tagDescription": "Premium amount for general liability coverage",
      "tagCategories": [
        "policy",
        "quote"
      ],
      "tagData": {
        "type": "text"
      },
      "createdAt": "2025-01-10T08:00:00.000Z",
      "updatedAt": "2025-01-10T08:00:00.000Z"
    }
  ],
  "totalCount": 2
}

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Query Parameters

​
id

Filter by smart tag ID (single UUID or array of UUIDs)

​
filterText
string

Search across quote number, description, and other text fields

​
sortBy
enum<string>
default:createdAt

Field to sort by (default createdAt)

Available options:
createdAt,
updatedAt,
tagName,
tagDisplayName
​
sortDirection
enum<string>
default:desc

Sort direction (default desc)

Available options:
asc,
desc
​
page
integer
default:1

Page number (1-based, default 1, page size 50)

Required range: x >= 1

Response

Paginated list of smart tags

​
items
object[]
​
totalCount
integer

Total number of matching smart tags across all pages