v3

latestOpenAPI 3.0.0©2023 All Rights Reserved2026-08-0659315450.0 KB
brand_template

WARNING: Brand templates were migrated to use a new ID format in September 2025. If your integration stores brand template IDs, you'll need to migrate to use the new IDs. Old brand template IDs will continue to be accepted for 6 months to give you time to migrate to the new IDs.

AVAILABILITY: To use this API, your integration 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

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

WARNING: Chart data fields and autofilling a video are preview features. There might be unannounced breaking changes to these features which won't produce a new API version.

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

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