# CreativeTemplate

> Type in domain **Creative Templates**

- HTML: [CreativeTemplate.html](CreativeTemplate.html)
- Raw SDL: [CreativeTemplate.sdl](CreativeTemplate.sdl)
- Covered by: [llms.txt](../llms.txt)

## Fields

- `id`: `ID!` — `CreativeTemplate` id.
- `brandId`: `ID!` _(deprecated)_ — Id of the `Brand` of the `CreativeTemplate`.
- `name`: `String!` — Name of the `CreativeTemplate`.
- `description`: `String` — Description of the `CreativeTemplate`.
- `mode`: `CreativeTemplateMode` _(beta)_ — Mode of the `CreativeTemplate`.
- `pages`: `[CreativeTemplatePage!]!` — Retrieve list of all `CreativeTemplatePage` items belonging to `CreativeTemplate`.
- `exportOptions`: `[CreativeTemplateExportOption!]!` — Retrieve list of all `CreativeTemplateExportOption` items belonging to `CreativeTemplate`.
- `variable` (`key`: `String!`): `CreativeTemplateVariable` — Retrieve a `CreativeTemplateVariable` item by `CreativeTemplateVariable` key.
- `variables`: `[CreativeTemplateVariable!]!` — Retrieve list of all `CreativeTemplateVariable` items belonging to `CreativeTemplate`.
- `assetId`: `ID` _(deprecated)_ — Retrieve Asset ID.
- `tags`: `[Tag]!` — Tags of the `CreativeTemplate`.

## Reach via

Example queries that can return this type from the root `Query`.

### `creativeTemplate`

```graphql
query CreativeTemplate {
  creativeTemplate(id: "…") {
    __typename
    description
    exportOptions {
      format
    }
    id
    mode
    name
    pages {
      previewUrl
      name
      height
      pageIndex
      width
    }
    tags {
      source
      value
    }
    variables {
      name
      connectionCount
      description
      key
      type
      value
      allowedColorValues {
        name
        id
        paletteName
        color { alpha }
      }
    }
  }
}
```

Raw: [`CreativeTemplate.sdl`](../examples/CreativeTemplate.sdl)

### `brand › creativeTemplates`

```graphql
query BrandCreativeTemplates {
  brand(id: "…") {
    creativeTemplates(limit: 25, page: 1) {
      items {
        __typename
        description
        exportOptions {
          format
        }
        id
        mode
        name
        pages {
          previewUrl
          name
          height
          pageIndex
          width
        }
        tags {
          source
          value
        }
        variables {
          name
          connectionCount
          description
          key
          type
          value
          allowedColorValues {
            name
            id
            paletteName
            color { alpha }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandCreativeTemplates.sdl`](../examples/BrandCreativeTemplates.sdl)

### `brands › creativeTemplates`

```graphql
query BrandsCreativeTemplates {
  brands {
    creativeTemplates(limit: 25, page: 1) {
      items {
        __typename
        description
        exportOptions {
          format
        }
        id
        mode
        name
        pages {
          previewUrl
          name
          height
          pageIndex
          width
        }
        tags {
          source
          value
        }
        variables {
          name
          connectionCount
          description
          key
          type
          value
          allowedColorValues {
            name
            id
            paletteName
            color { alpha }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandsCreativeTemplates.sdl`](../examples/BrandsCreativeTemplates.sdl)