The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
Canva Developers SDK
The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
API reference
Intents
Intents: Content
Intents: Design
Intents: Test
Platform: Test

getBrandTemplateMetadata

API reference for the getBrandTemplateMetadata method.

Return metadata for a brand template given its ID.

Usage: Get brand template metadata

import {
getBrandTemplateMetadata,
requestBrandTemplates,
type BrandTemplateId,
} from "@canva/design";
const selection = await requestBrandTemplates();
if (selection.status === "aborted") return;
const templateId = selection.brandTemplates[0]?.token as BrandTemplateId | undefined;
if (!templateId) return;
const metadata = await getBrandTemplateMetadata(templateId);
TYPESCRIPT

Parameters

idBrandTemplateId
Required

A unique identifier that references a brand template.

Returns

Metadata for a brand template. This is a Promise that resolves with the following object:

domainstring

The only valid value is "brand".

datasetDataField[]
Optional

Metadata for a data field in a design or brand template.

labelstring
typestring

Available values:

  • "image"
  • "text"
  • "chart"
keywordsstring[]

A list of keywords contained in a template.