design

Changed on

Gets the dataset definition of a design. If the design 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 brand template, use the Get brand template dataset API.

</Note>

Available data field types include:

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

Use the returned field names and types to build the data payload for the Create a design autofill job API with type: create_from_design.

get/v1/designs/{designId}/dataset

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/designs/{designId}/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: design:content:read)

Path parameters

designIdstring required

The design 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