All endpoints

DocsAPIAccount

GET/brands

List saved brands and where each site stands

The business's saved banner brands (colours, fonts, logo, corners) with every numbered version, and each site's state against the brand it follows: up to date, some versions behind, or changed on that site.

Auth header

Authorization: Bearer tsk_live_…

The key needssites:read

Example request

curl "https://app.tagsentry.ai/api/v1/brands" \  -H "Authorization: Bearer tsk_live_…"

Response 200

  • brandsarray of objectrequired
  • brands[].brandIdstringrequired
  • brands[].namestringrequired
  • brands[].parentBrandIdstring | nullrequired

    The agency base this client brand inherits from.

  • brands[].latestVersionnumberrequired
  • brands[].versionsarray of objectrequired
  • brands[].versions[].versionnumberrequired
  • brands[].versions[].valuesobjectrequired
  • brands[].versions[].values.textstringoptional
  • brands[].versions[].values.bgstringoptional
  • brands[].versions[].values.hlstringoptional
  • brands[].versions[].values.headingFontstringoptional
  • brands[].versions[].values.bodyFontstringoptional
  • brands[].versions[].values.logostringoptional
  • brands[].versions[].values.cornersstringoptional

    One of square, soft, round, site

  • brands[].versions[].notestring | nullrequired
  • brands[].versions[].approvedBystring | nullrequired
  • brands[].versions[].approvedAtstring | nullrequired
  • sitesarray of objectrequired
  • sites[].siteIdstringrequired
  • sites[].domainstringrequired
  • sites[].brandIdstring | nullrequired
  • sites[].versionnumber | nullrequired
  • sites[].versionsBehindnumberrequired
  • sites[].changedOnSitearray of stringrequired

    Brand values this site changed from its version.

  • sites[].statearray of stringrequired

    Up to date, N versions behind, Changed on this site.

  • sites[].hasBannerbooleanrequired

Example response

{  "brands": [    {      "brandId": "3f6c1b8e-2d4a-4c7e-9a51-0b8f2e6d7c10",      "name": "_ga",      "parentBrandId": "3f6c1b8e-2d4a-4c7e-9a51-0b8f2e6d7c10",      "latestVersion": 0,      "versions": [        {          "version": 0,          "values": {            "text": "…",            "bg": "…",            "hl": "…",            "headingFont": "…",            "bodyFont": "…",            "logo": "…",            "corners": "square"          },          "note": "…",          "approvedBy": "…",          "approvedAt": "2026-09-26T14:02:00.000Z"        }      ]    }  ],  "sites": [    {      "siteId": "3f6c1b8e-2d4a-4c7e-9a51-0b8f2e6d7c10",      "domain": "silverpine.example",      "brandId": "3f6c1b8e-2d4a-4c7e-9a51-0b8f2e6d7c10",      "version": 0,      "versionsBehind": 0,      "changedOnSite": [        "…"      ],      "state": [        "…"      ],      "hasBanner": false    }  ]}
More about this endpoint

A site never moves to a new version until someone applies it.

Errors401 · 403 · 429 · 500
  • 401Missing, malformed, unknown, revoked or expired API key. These are deliberately indistinguishable in the response: distinguishing them would confirm to a caller that a token was once real.
  • 403The key authenticated but does not carry the scope(s) this operation requires, or (`domain_not_verified`) the site's domain is not verified, so its consent records are not released.
  • 429A rate limit or quota was exceeded. The body names WHICH one.
  • 500Something failed on our side. The requestId in the body is what to quote.

Every error has the same body: { error: { code, message, requestId } }.

From the OpenAPI document, version 2026-08-26. Raw OpenAPI