brand_template

Changed on

AVAILABILITY: To use this API, your app must act on behalf of a user that's on a Canva plan with access to brand templates (such as Canva Pro, Canva Teams, or Canva Enterprise).

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

get/v1/brand-templates

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/brand-templates
  • Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: brandtemplate:meta:read)

Query parameters

querystring

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

continuationstring

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.

limitinteger

The number of brand templates to return.

ownership'any' | 'owned' | 'shared'

Filter the list of brand templates based on the user's ownership of the brand templates.

sort_by'relevance' | 'modified_descending' | 'modified_ascending' | 'title_descending' | 'title_ascending'

Sort the list of brand templates.

dataset'any' | 'non_empty'

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.

Response

OK

continuationstring

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
    }
  ]
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

  • 5ea5a3f48e72Revision changes
    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status