Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Templates

Get Template Details

Use this API to retrieve detailed information of a template, including banner setup, preference center setup and the cookie list.

get/api/cmp/v1/templates/{templateId}

Path parameters

templateIdstring uuid required

Unique identifier of the template

Query parameters

languagestring

Optional language-country code to retrieve localized template content

Response

OK

bannerAttributesobject

Map of branding attributes keyed by attribute name - For Banner

pcAttributesobject

Map of branding attributes keyed by attribute name - For Preferences Center

clistattributesobject

Example response

{
  "template": {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "currentVersion": 12,
    "templateName": "my-template-2026",
    "templateType": "GDPR",
    "status": "DRAFTED",
    "orgId": "org-123",
    "orgName": "OneTrust",
    "languages": [
      "en",
      "fr-CA",
      "es"
    ]
  },
  "pcAdvancedConfig": {
    "nodeId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "sequence": 1,
    "attributes": {
      "showBanner": {
        "value": true,
        "type": "BOOLEAN"
      }
    },
    "displayGroup": {
      "name": "Strictly Necessary Cookies",
      "type": "COOKIE",
      "creationMode": "MANUAL",
      "description": "These cookies are essential for the website to function.",
      "mobileDescription": "Essential cookies for mobile app.",
      "ottDescription": "Essential cookies for OTT app.",
      "mobileName": "Essential Cookies",
      "ottName": "Essential Cookies",
      "showMobDesc": true,
      "showOTTDesc": true,
      "descriptionLegal": "Legal text for this category.",
      "customCategoryId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "customCategoryName": "C0001",
      "enable": true,
      "show": true,
      "iabIllustrations": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "displayGroupId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "illustration": "This is an example illustration",
          "sequence": 1,
          "custom": false
        }
      ]
    },
    "cookiepediaCategoryId": 123
  },
  "bannerAttributes": {
    "dBannerButtonColor": {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "dBannerButtonColor",
      "value": "#000000",
      "type": "STRING",
      "section": "BANNER",
      "important": false
    },
    "dBannerPosition": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "dBannerPosition",
      "value": "bottom",
      "type": "STRING",
      "section": "BANNER",
      "important": false
    }
  },
  "pcAttributes": {
    "dPCButtonColor": {
      "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "name": "dPCButtonColor",
      "value": "#0066FF",
      "type": "STRING",
      "section": "PREFERENCE_CENTER",
      "important": false
    },
    "dPCShowCookieList": {
      "id": "b2c3d4e5-f6g7-8901-bcde-f12345678901",
      "name": "dPCShowCookieList",
      "value": true,
      "type": "BOOLEAN",
      "section": "PREFERENCE_CENTER",
      "important": false
    }
  }
}