Get design autofill job

Get the status and results of an autofill job, including the autofilled design.

Get the result of a design autofill job that was created using the Create a design autofill job API.

You might need to make multiple requests to this endpoint until you get a success or failed status.

GET https://api.canva.com/rest/v1/autofills/{jobId}

This operation is rate limited to 60 requests per minute for each user of your integration.

This endpoint requires a valid access token that acts on behalf of a user. The token must have the following scopes (permissions):

  • design:meta:read

For more information, see Scopes.

#Authorizationstring
Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#jobIdstring
Required

The design autofill job ID.

Examples for using the /v1/autofills/{jobId} endpoint:

curl --request GET 'https://api.canva.com/rest/v1/autofills/{jobId}' \
--header 'Authorization: Bearer {token}'
sh

If successful, the endpoint returns a 200 response with a JSON body with the following parameters:

#jobDesignAutofillJob

Details about the autofill job.

Properties of job
#idstring

ID of the asynchronous job that is creating the design using the provided data.

#statusstring

Status of the design autofill job. This can be one of the following:

  • in_progress
  • success
  • failed
#resultDesignAutofillJobResult
Optional

Result of the design autofill job. Only present if job status is success.

Properties of result
#typestring

This can be one of the following:

  • create_design: Design has been created and saved to user's root folder.
#designDesignSummary

Basic details about the design, such as the design's ID, title, and URL.

Properties of design
#idstring

The design ID.

#urlsDesignLinks

A temporary set of URLs for viewing or editing the design.

Properties of urls
#edit_urlstring

A temporary editing URL for the design.

#view_urlstring

A temporary viewing URL for the design.

#created_atinteger

When the design was created in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the design was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#titlestring
Optional

The design title.

#urlstring
Optional

URL of the design.

#thumbnailThumbnail
Optional

A thumbnail image representing the object.

Properties of thumbnail
#widthinteger

The width of the thumbnail image in pixels.

#heightinteger

The height of the thumbnail image in pixels.

#urlstring

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.

#page_countinteger
Optional

The total number of pages in the design. Some design types don't have pages (for example, Canva docs).

#errorAutofillError
Optional

If the autofill job fails, this object provides details about the error.

Properties of error
#codestring

This can be one of the following:

  • autofill_error
  • thumbnail_generation_error
  • create_design_error
#messagestring

A human-readable description of what went wrong.

{
"job": {
"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
"status": "in_progress"
}
}
json
{
"job": {
"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
"status": "success",
"result": {
"type": "create_design",
"design": {
"id": "DAFVztcvd9z",
"title": "My summer holiday",
"url": "https://www.canva.com/design/DAFVztcvd9z/edit",
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
}
}
}
}
}
json
{
"job": {
"id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
"status": "failed",
"error": {
"code": "autofill_error",
"message": "Error autofilling design from brand template"
}
}
}
json

To get started, generate an access token or provide your own below