Get brand template

Get the metadata for one of the user's brand templates.

Retrieves the metadata for a brand template.

GET https://api.canva.com/rest/v1/brand-templates/{brandTemplateId}

This operation is rate limited to 100 requests per minute for each user of your integration.

This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):

  • brandtemplate:meta:read

For more information, see Scopes.

#Authorizationstring
Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#brandTemplateIdstring
Required

The brand template ID.

Examples for using the /v1/brand-templates/{brandTemplateId} endpoint:

curl --request GET 'https://api.canva.com/rest/v1/brand-templates/{brandTemplateId}' \
--header 'Authorization: Bearer {token}'
sh

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

#brand_templateBrandTemplate

An object representing a brand template with associated metadata.

Properties of brand_template
#idstring

The brand template ID.

#titlestring

The brand template title, as shown in the Canva UI.

#view_urlstring

A URL Canva users can visit to view the brand template.

#create_urlstring

A URL Canva users can visit to create a new design from the template.

#created_atinteger

When the brand template was created, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the brand template was last updated, as a Unix timestamp (in seconds since the Unix Epoch).

#thumbnailThumbnail
Optional

A thumbnail image representing the object.

Properties of thumbnail
#widthinteger

The width of the thumbnail image in pixels.

#heightinteger

The height of the thumbnail image in pixels.

#urlstring

A URL for retrieving the thumbnail image. This URL expires after 15 minutes. This URL includes a query string that's required for retrieving the thumbnail.

{
"brand_template": {
"id": "DEMzWSwy3BI",
"title": "Advertisement Template",
"view_url": "https://www.canva.com/design/DAE35hE8FA4/view",
"create_url": "https://www.canva.com/design/DAE35hE8FA4/remix",
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
},
"created_at": 1704110400,
"updated_at": 1719835200
}
}
json

To get started, generate an access token or provide your own below