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: Asset
Intents: Content
Intents: Design
Intents: Test
Platform: Test

requestBrandTemplates

API reference for the requestBrandTemplates 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.

Trigger brand template selection panel and returns the selected template token.

Usage: Request brand templates

import { requestBrandTemplates } from "@canva/design";
const response = await requestBrandTemplates();
if (response.status === 'aborted') return;
const { token } = response.brandTemplates[0];
TYPESCRIPT

Returns

Response object from the RequestBrandTemplate operation. This is a Promise that resolves with the following object:

Response object from the RequestBrandTemplate operation completed successfully.

statusstring

The only valid value is "completed".

brandTemplatesRequestBrandTemplatesResponseContent[]

Response object from the RequestBrandTemplate operation completed successfully.

tokenstring

Response object from the RequestBrandTemplate operation that was aborted.

statusstring

The only valid value is "aborted".

Permissions

To use this method, the canva:brandtemplate:read permission must be enabled for the app. To learn more, see Permissions.