Soon, all brand template IDs will be updated to a new format. If your integration stores brand template IDs, you'll need to migrate to use the new IDs. After we implement this change, you'll have 6 months to migrate before the old IDs are removed.
To use this API, your integration must act on behalf of a user that's a member of a Canva Enterprise(opens in a new tab or window) organization.
Get a list of the brand templates(opens in a new tab or window) the user has access to.
HTTP method and URL path
https://api.canva.com /rest /v1 /brand-templates
This operation is rate limited to 100 requests per minute for each user of your integration.
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
Query parameters
query
string
Lets you search the brand templates available to the user using a search term or terms.
continuation
string
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.
ownership
string
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_by
string
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.
dataset
string
Filter the list of brand templates based on the brand templates' dataset definitions. Brand templates with dataset definitions are mainly used with the Autofill APIs. This can be one of the following:
any
: (Default) Brand templates with and without dataset definitions.non_empty
: Brand templates with one or more data fields defined.empty
: Brand templates with no data fields defined.
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}'
const fetch = require("node-fetch");fetch("https://api.canva.com/rest/v1/brand-templates", {method: "GET",headers: {"Authorization": "Bearer {token}",},}).then(async (response) => {const data = await response.json();console.log(data);}).catch(err => console.error(err));
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());}}
import requestsheaders = {"Authorization": "Bearer {token}"}response = requests.get("https://api.canva.com/rest/v1/brand-templates",headers=headers)print(response.json())
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);};
package mainimport ("fmt""io""net/http")func main() {url := "https://api.canva.com/rest/v1/brand-templates"req, _ := http.NewRequest("GET", url, nil)req.Header.Add("Authorization", "Bearer {token}")res, _ := http.DefaultClient.Do(req)defer res.Body.Close()body, _ := io.ReadAll(res.Body)fmt.Println(string(body))}
$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;}
require 'net/http'require 'uri'url = URI('https://api.canva.com/rest/v1/brand-templates')http = Net::HTTP.new(url.host, url.port)http.use_ssl = truerequest = Net::HTTP::Get.new(url)request['Authorization'] = 'Bearer {token}'response = http.request(request)puts response.read_body
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
items
BrandTemplate[]
The list of brand templates.
Properties of items
id
string
The brand template ID.
title
string
The brand template title, as shown in the Canva UI.
view_url
string
A URL Canva users can visit to view the brand template.
create_url
string
A URL Canva users can visit to create a new design from the template.
created_at
integer
When the brand template was created, as a Unix timestamp (in seconds since the Unix Epoch).
updated_at
integer
When the brand template was last updated, as a Unix timestamp (in seconds since the Unix Epoch).
thumbnail
Thumbnail
A thumbnail image representing the object.
Properties of thumbnail
width
integer
The width of the thumbnail image in pixels.
height
integer
The height of the thumbnail image in pixels.
url
string
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.
continuation
string
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.
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/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}]}