---
title: "Get Template Details"
method: GET
path: "/api/cmp/v1/templates/{templateId}"
tags: ["Templates"]
---

# Get Template Details

`GET /api/cmp/v1/templates/{templateId}`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/cmp/v1/templates/{templateId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COOKIE_READ`

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

## Path parameters

- `templateId` string, uuid, required

## Query parameters

- `language` string

## Response `200`

OK

- TemplateDetailDto
  - `template` TemplateDto
    - `id` string, uuid: UUID of the template
    - `currentVersion` integer: The current version number of the template
    - `templateName` string: Name of the template
    - `templateType` 'GDPR' | 'IAB' | 'CCPA' | 'IAB2' | 'GENERIC' | 'LGPD' | 'GENERIC_PROMPT' | 'CPRA' | 'CDPA' | 'USNATIONAL' | 'COLORADO' | 'CTDPA' | 'UCPA' | 'QUEBEC' | 'IABC' | 'IAB2V2' | 'OCPA' | 'MODPA' | 'VCDPA' | 'UKGDPR' | 'IND_DPDPA' | 'CUSTOM': The category of the template
    - `status` 'DRAFTED' | 'ACTIVATED': The template's status, published if status is ACTIVATED
    - `isDefault` boolean: Indicates if the template is the default template
    - `isUniversalDefault` boolean: Indicates if the template is the universal default template
    - `isOrgDefault` boolean: Indicates if the template is the default template for the organization
    - `orgDefaultEnabled` boolean: Indicates if the organization default is enabled
    - `orgId` string: Organization ID
    - `orgName` string: Organization name
    - `languages` string[]: List of enabled language codes for this template
  - `pcAdvancedConfig` DisplayGroupTreeDto
    - `nodeId` string, uuid: Unique identifier of the tree node.
    - `sequence` integer: Sequence order of the node within its level.
    - `attributes` object: Map of attributes associated with this display group node.
    - `displayGroup` DisplayGroupEntityDto
      - `id` string, uuid
      - `name` string: Name of the display group.
      - `type` 'ROOT' | 'BRANCH' | 'COOKIE' | 'IAB' | 'IAB2_PURPOSE' | 'IAB2_STACK' | 'IAB2_FEATURE' | 'IAB2_SPL_PURPOSE' | 'IAB2_SPL_FEATURE' | 'MOB_DEVICE_PERMISSION' | 'IAB2V2_PURPOSE' | 'IAB2V2_STACK' | 'IAB2V2_FEATURE' | 'IAB2V2_SPL_PURPOSE' | 'IAB2V2_SPL_FEATURE' | 'IAB2V2_DATA_CATEGORY': Type of the display group.
      - `creationMode` 'SEEDED' | 'MANUAL': Creation mode of the display group.
      - `description` string: Description of the display group for web platforms.
      - `mobileDescription` string: Description of the display group for mobile platforms.
      - `ottDescription` string: Description of the display group for OTT (Over-The-Top) platforms.
      - `mobileName` string: Name of the display group for mobile platforms.
      - `ottName` string: Name of the display group for OTT platforms.
      - `showMobDesc` boolean: Indicates if mobile description should be displayed.
      - `showOTTDesc` boolean: Indicates if OTT description should be displayed.
      - `alwaysShowCategory` boolean: Indicates if the category should always be shown on web platforms.
      - `mobileAlwaysShowCategory` boolean: Indicates if the category should always be shown on mobile platforms.
      - `ottAlwaysShowCategory` boolean: Indicates if the category should always be shown on OTT platforms.
      - `descriptionLegal` string: Legal description of the display group.
      - `customCategoryId` string, uuid: Unique identifier of the custom category.
      - `customCategoryName` string: Name of the custom category.
      - `enable` boolean: Indicates if the display group is enabled.
      - `show` boolean: Indicates if the display group should be shown.
      - `iabIllustrations` IABSourceIllustrationsDto[]: List of IAB source illustrations associated with this display group.
        - `id` string, uuid
        - `displayGroupId` string, uuid: Unique identifier of the display group.
        - `illustration` string: Illustration text.
        - `sequence` integer: Sequence order of the illustration.
        - `custom` boolean
      - `machineTranslated` boolean
      - `iabPurpose` boolean
    - `cookiepediaCategoryId` integer: Cookiepedia category ID associated with this display group.
  - `bannerAttributes` object: Map of branding attributes keyed by attribute name - For Banner
  - `pcAttributes` object: Map of branding attributes keyed by attribute name - For Preferences Center
  - `clistattributes` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-cookie-consent/revisions/b4fb4606f973?raw)