# Brand

> Type in domain **Brands**

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

Implements: `Node`

## Fields

- `id`: `ID!` — `Brand` Id.
- `name`: `String!` — `Brand` name.
- `rgbaColor`: `RgbaColor` — `Brand` color.
- `avatar`: `Url` — `Brand` avatar.
- `slug`: `String` — `Brand` slug.
- `projects` (`types`: `[ProjectType]`): `[Project]` _(deprecated)_ — Retrieve all `Projects`.
- `libraries` (`limit`: `Int`, `page`: `Int`, `query`: `LibraryQueryInput`): `LibraryItems` — Retrieve all `Library` items.
- `workspaceProjects` (`limit`: `Int`, `page`: `Int`, `query`: `WorkspaceProjectQueryInput`): `WorkspaceItems` — Retrieve all `Workspace` items.
- `guidelines` (`locale`: `String`, `language`: `LanguageCode`, `limit`: `Int`, `page`: `Int`): `GuidelineItems` _(beta)_ — Paginated list of `Guideline` items for `Brand`.
- `customMetadataProperties`: `[CustomMetadataProperty!]!` — `Brand` `CustomMetadataProperty` items list.
- `creativeTemplates` (`limit`: `Int`, `page`: `Int`, `query`: `CreativeTemplateQueryInput`): `CreativeTemplateItems!` — Retrieve all `CreativeTemplate` items.
- `essentials`: `BrandEssentials!` _(beta)_ — The brand essentials.
- `search` (`limit`: `Int`, `page`: `Int`, `query`: `BrandQueryInput`): `BrandSearchItems` _(beta)_ — Search for the assets on the brand level.
- `enhancedSearch` (`limit`: `Int`, `page`: `Int`, `query`: `BrandQueryInput`): `BrandEnhancedSearchItems` _(beta)_ — Enhanced search for the assets on the brand level. Includes natural search and exact term search

## Related mutations

- [`createBrand`](../mutation/createBrand.md)
- [`deleteBrand`](../mutation/deleteBrand.md)
- [`updateBrand`](../mutation/updateBrand.md)

## Reach via

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

### `brand`

```graphql
query Brand {
  brand(id: "…") {
    __typename
    avatar
    creativeTemplates {
      total
      page
      limit
      hasNextPage
      items {
        name
        id
        description
        mode
        exportOptions { format }
        pages { previewUrl }
      }
    }
    customMetadataProperties {
      name
      id
      createdAt
      defaultValue
      forbiddenDependeePropertyIds
      helpText
      creator {
        __typename
        name
        id
      }
      dependency {
        __typename
        propertyId
        type
        ... on CustomMetadataPropertySelectValueTypeDependencyTypeEquals {
          propertyOptionId
        }
        ... on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf {
          propertyOptionIds
        }
      }
      modifier {
        __typename
        name
        id
      }
      permissions {
        basic { permissionLevel }
        custom { permissionLevel }
      }
      type {
        __typename
        name
        ... on CustomMetadataPropertyTypeCatalog {
          allowedLinkedColumnIds
          allowMultiSelect
        }
      }
    }
    enhancedSearch {
      hasNextPage
      limit
      page
      edges {
        title
        node {
          __typename
          ... on Audio { id }
          ... on Document { id }
          ... on EmbeddedContent { id }
          ... on File { id }
          ... on Image { id }
          ... on Video { id }
        }
      }
      items {
        __typename
        ... on Audio { id }
        ... on Document { id }
        ... on EmbeddedContent { id }
        ... on File { id }
        ... on Image { id }
        ... on Video { id }
      }
    }
    essentials {
      colorPalettes {
        total
        page
        limit
        hasNextPage
        items { id }
      }
      fontFamilies {
        total
        page
        limit
        hasNextPage
        items { id }
      }
    }
    guidelines {
      total
      page
      limit
      hasNextPage
      items {
        name
        id
        url
        availableBlockTypes { id }
        color { alpha }
      }
    }
    id
    libraries {
      total
      page
      limit
      hasNextPage
      items {
        __typename
        name
        id
        assets {
          total
          page
          limit
          hasNextPage
          items { id }
        }
        browse { __typename }
      }
    }
    name
    rgbaColor {
      alpha
      blue
      green
      red
    }
    search {
      total
      page
      limit
      hasNextPage
      items {
        __typename
        ... on Audio { id }
        ... on Document { id }
        ... on EmbeddedContent { id }
        ... on File { id }
        ... on Image { id }
        ... on Video { id }
      }
    }
    slug
    workspaceProjects {
      total
      page
      limit
      hasNextPage
      items {
        name
        id
        isArchived
        assets {
          total
          page
          limit
          hasNextPage
          items { id }
        }
        browse { __typename }
      }
    }
  }
}
```

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

### `brands`

```graphql
query Brands {
  brands {
    __typename
    avatar
    creativeTemplates {
      total
      page
      limit
      hasNextPage
      items {
        name
        id
        description
        mode
        exportOptions { format }
        pages { previewUrl }
      }
    }
    customMetadataProperties {
      name
      id
      createdAt
      defaultValue
      forbiddenDependeePropertyIds
      helpText
      creator {
        __typename
        name
        id
      }
      dependency {
        __typename
        propertyId
        type
        ... on CustomMetadataPropertySelectValueTypeDependencyTypeEquals {
          propertyOptionId
        }
        ... on CustomMetadataPropertySelectValueTypeDependencyTypeOneOf {
          propertyOptionIds
        }
      }
      modifier {
        __typename
        name
        id
      }
      permissions {
        basic { permissionLevel }
        custom { permissionLevel }
      }
      type {
        __typename
        name
        ... on CustomMetadataPropertyTypeCatalog {
          allowedLinkedColumnIds
          allowMultiSelect
        }
      }
    }
    enhancedSearch {
      hasNextPage
      limit
      page
      edges {
        title
        node {
          __typename
          ... on Audio { id }
          ... on Document { id }
          ... on EmbeddedContent { id }
          ... on File { id }
          ... on Image { id }
          ... on Video { id }
        }
      }
      items {
        __typename
        ... on Audio { id }
        ... on Document { id }
        ... on EmbeddedContent { id }
        ... on File { id }
        ... on Image { id }
        ... on Video { id }
      }
    }
    essentials {
      colorPalettes {
        total
        page
        limit
        hasNextPage
        items { id }
      }
      fontFamilies {
        total
        page
        limit
        hasNextPage
        items { id }
      }
    }
    guidelines {
      total
      page
      limit
      hasNextPage
      items {
        name
        id
        url
        availableBlockTypes { id }
        color { alpha }
      }
    }
    id
    libraries {
      total
      page
      limit
      hasNextPage
      items {
        __typename
        name
        id
        assets {
          total
          page
          limit
          hasNextPage
          items { id }
        }
        browse { __typename }
      }
    }
    name
    rgbaColor {
      alpha
      blue
      green
      red
    }
    search {
      total
      page
      limit
      hasNextPage
      items {
        __typename
        ... on Audio { id }
        ... on Document { id }
        ... on EmbeddedContent { id }
        ... on File { id }
        ... on Image { id }
        ... on Video { id }
      }
    }
    slug
    workspaceProjects {
      total
      page
      limit
      hasNextPage
      items {
        name
        id
        isArchived
        assets {
          total
          page
          limit
          hasNextPage
          items { id }
        }
        browse { __typename }
      }
    }
  }
}
```

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