Brand templates

Overview Get brand template Get brand template dataset List brand templates

List brand templates

List all the user's brand templates.

Get a list of the brand templates the user has access to.

HTTP method and URL path

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

Authentication

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.

Header parameters

#Authorizationstring

Required

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

For example: Authorization: Bearer {token}

Query parameters

#querystring

Optional

Lets you search the brand templates available to the user using a search term or terms.

#continuationstring

Optional

If the success response contains a continuation token, the user has access to more brand templates you can list. You can use this token as a query parameter and retrieve more templates from the list, for example /v1/brand-templates?continuation={continuation}. To retrieve all the brand templates available to the user, you might need to make multiple requests.

#ownershipstring

Optional

Filter the list of brand templates based on the user's ownership of the brand templates. This can be one of the following:

any: (Default) Brand templates owned by and shared with the user.
owned: Brand templates owned by the user.
shared: Brand templates shared with the user.

#sort_bystring

Optional

Sort the list of brand templates. This can be one of the following:

relevance: (Default) Sort results using a relevance algorithm.
modified_descending: Sort results by the date last modified in descending order.
modified_ascending: Sort results by the date last modified in ascending order.
title_descending: Sort results by title in descending order.
title_ascending: Sort results by title in ascending order.

Example request

Examples for using the /v1/brand-templates endpoint:

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

import java.io.IOException;
import java.net.URI;
import java.net.http.*;

public class ApiExample {
    public static void main(String[] args) throws IOException, InterruptedException {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.canva.com/rest/v1/brand-templates"))
            .header("Authorization", "Bearer {token}")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}

java

using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://api.canva.com/rest/v1/brand-templates"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};

csharp

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.canva.com/rest/v1/brand-templates",
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer {token}',
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if (empty($err)) {
  echo $response;
} else {
  echo "Error: " . $err;
}

php

Success response

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

#itemsBrandTemplate[]

The list of brand templates.

Properties of items

#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.

#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.

#continuationstring

Optional

Example response

{
  "continuation": "RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN",
  "items": [
    {
      "id": "DEMzWSwy3BI",
      "title": "Advertisement Template",
      "view_url": "https://www.canva.com/design/DAE35hE8FA4/view",
      "create_url": "https://www.canva.com/templates/DADao7wZnAA/remix",
      "thumbnail": {
        "width": 595,
        "height": 335,
        "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
      }
    }
  ]
}

json

List brand templates

HTTP method and URL path

Authentication

Header parameters

Query parameters

Example request

Success response

Example response

Try it out

Step 1: Enter your access token