API reference
Asset: Test
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElementaddPageapplyTemplateautofillDesignbulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetBrandTemplateMetadatagetCurrentPageContextgetCurrentPageMetadatagetDefaultPageDimensionsgetDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestApplyPublicTemplaterequestBrandTemplatesrequestDataFieldMatchingrequestExportselection.registerOnChangesetCurrentPageBackgroundsetDataFieldLabelVisibilityui.startDragToCursorui.startDragToPointui.startDragChangelog
Design: Test
Error
Error: Test
Intents
Intents: Content
Intents: Data
Intents: Design
Intents: Test
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Platform: Test
User
User: 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
idBrandTemplateIdRequired
A unique identifier that references a brand template.
Returns
Metadata for a brand template. This is a Promise that resolves with the following object:
domainstringThe only valid value is "brand".
datasetDataField[]Optional
Metadata for a data field in a design or brand template.
labelstringtypestringAvailable values:
"image""text""chart"
keywordsstring[]A list of keywords contained in a template.