getDesignTemplateMetadata

API reference for the getDesignTemplateMetadata method.

This API is a preview. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

Retrieves information about the template that was used in a design.

Usage: Get design template metadata

import { getDesignTemplateMetadata } from "@canva/design";
const templateMetadata = await getDesignTemplateMetadata();
const { keywords, domain } = templateMetadata;
TYPESCRIPT

Returns

Information about the template that was used in a design. This is a Promise that resolves with the following object:

templatesIterable<TemplateMetadata>
Optional

The templates applied to the pages within the design.

keywordsstring[]

A list of keywords contained in a template.

domainstring

Determines the domain of the template. This could be public, brand or personal.

Available values:

  • "public"
  • "brand"
  • "personal"