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

Gets the dataset definition of a brand template. If the brand template contains autofill data fields, this API returns an object with the data field names and the type of data they accept.

<Note>

To get the dataset definition of a design, use the Get design dataset API.

</Note>

Available data field types include:

  • Images (which you can autofill with an image or a video asset)
  • Text
  • Charts
  • Sheets

You can autofill a brand template using the Create a design autofill job API.

get/v1/brand-templates/{brandTemplateId}/dataset

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/brand-templates/{brandTemplateId}/dataset
  • 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:content:read)

Path parameters

brandTemplateIdstring required

The brand template ID.

Response

OK

datasetobject

The dataset definition. It contains the data inputs available for use with the Create design autofill job API.

Example response

{
  "dataset": {
    "cute_pet_image_of_the_day": {
      "type": "image"
    },
    "cute_pet_witty_pet_says": {
      "type": "text"
    },
    "cute_pet_sales_chart": {
      "type": "chart"
    }
  }
}

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

  • ded190b8f3baRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • info

      added sheet discriminator mapping keys to the / response property for the response status