Skip to main content

PaginatedResponse[TagRead]

items object[]required
  • Array [
  • idIdrequired

    Unique numeric identifier of the record.

    product_idProduct Idrequired

    ID of the product (workspace) that owns this record. Most endpoints scope access by product.

    nameNamerequired

    Tag name.

    descriptionDescriptionrequired

    What the tag means; used by the tags-extractor LLM to decide when to apply it.

    crm_id objectrequired

    Identifier of the matching record in the connected external CRM, if any.

    anyOf
    string
    is_activeIs Activerequired

    Whether the tag is active.

    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

    config objectrequired

    Free-form tag configuration (JSON).

    property name*any

    Free-form tag configuration (JSON).

  • ]
  • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[TagRead]
    {
    "items": [
    {
    "id": 0,
    "product_id": 0,
    "name": "string",
    "description": "string",
    "crm_id": "string",
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "config": {}
    }
    ],
    "page": 0,
    "limit": 0,
    "total": 0,
    "pages": 0
    }