Get design import job

Get the status and results of a design import job, including the imported design.

Gets the result of a design import job created using the Create design import job API.

You might need to make multiple requests to this endpoint until you get a success or failed status. For more information on the workflow for using asynchronous jobs, see API requests and responses.

HTTP method and URL path

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

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

Authentication

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

  • design:content:write

For more information, see Scopes.

Header parameters

Authorizationstring
REQUIRED

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

For example: Authorization: Bearer {token}

Path parameters

jobIdstring
REQUIRED

The design import job ID.

Example request

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

curl --request GET 'https://api.canva.com/rest/v1/imports/{jobId}' \
--header 'Authorization: Bearer {token}'
SH
const fetch = require("node-fetch");
fetch("https://api.canva.com/rest/v1/imports/{jobId}", {
method: "GET",
headers: {
"Authorization": "Bearer {token}",
},
})
.then(async (response) => {
const data = await response.json();
console.log(data);
})
.catch(err => console.error(err));
JS
import java.io.IOException;
import java.net.URI;
import java.net.http.*;
public class ApiExample {
public static void main(String[] args) throws IOException, InterruptedException {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.canva.com/rest/v1/imports/{jobId}"))
.header("Authorization", "Bearer {token}")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(
request,
HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.body());
}
}
JAVA
import requests
headers = {
"Authorization": "Bearer {token}"
}
response = requests.get("https://api.canva.com/rest/v1/imports/{jobId}",
headers=headers
)
print(response.json())
PY
using System.Net.Http;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://api.canva.com/rest/v1/imports/{jobId}"),
Headers =
{
{ "Authorization", "Bearer {token}" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
};
CSHARP
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.canva.com/rest/v1/imports/{jobId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer {token}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
GO
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.canva.com/rest/v1/imports/{jobId}",
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer {token}',
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if (empty($err)) {
echo $response;
} else {
echo "Error: " . $err;
}
PHP
require 'net/http'
require 'uri'
url = URI('https://api.canva.com/rest/v1/imports/{jobId}')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer {token}'
response = http.request(request)
puts response.read_body
RUBY

Success response

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

jobDesignImportJob

The status of the design import job.

Properties of job
idstring

The ID of the design import job.

statusstring

The status of the design import job. This can be one of the following:

  • failed
  • in_progress
  • success
resultDesignImportJobResult
OPTIONAL
Properties of result
designsDesignSummary[]

A list of designs imported from the external file. It usually contains one item. Imports with a large number of pages or assets are split into multiple designs.

Properties of designs
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.

This is not a permanent URL, it is only valid for 30 days.

view_urlstring

A temporary viewing URL for the design.

This is not a permanent URL, it is only valid for 30 days.

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

errorDesignImportError
OPTIONAL

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

Properties of error
codestring

A short string about why the import failed. This field can be used to handle errors programmatically. This can be one of the following:

  • design_creation_throttled
  • design_import_throttled
  • duplicate_import
  • internal_error
  • invalid_file
  • fetch_failed
messagestring

A human-readable description of what went wrong.

Example responses

In progress job

{
"job": {
"id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
"status": "in_progress"
}
}
JSON

Successfully completed job

{
"job": {
"id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
"status": "success",
"result": {
"designs": [
{
"id": "DAGQm2AkzOk",
"title": "My Awesome Design",
"thumbnail": {
"width": 376,
"height": 531,
"url": "https://document-export.canva.com/..."
},
"urls": {
"edit_url": "https://www.canva.com/api/design/...",
"view_url": "https://www.canva.com/api/design/..."
},
"created_at": 1726198998,
"updated_at": 1726199000
}
]
}
}
}
JSON

Failed job

{
"job": {
"id": "e08861ae-3b29-45db-8dc1-1fe0bf7f1cc8",
"status": "failed",
"error": {
"code": "invalid_file",
"message": "Document couldn't be imported because the file is corrupt."
}
}
}
JSON

Try it out

Step 1: Enter your access token

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