9.7 KiB
Skip navigation
Skip to main content
-
Documentation
-
Blogs
Designs
OverviewCreate designList designsGet designGet design pages[Get design export formats](/docs/connect/api-reference/designs/get-design-export- formats/)
Get design
Get the metadata for one of the user's designs.
Copy page
Gets the metadata for a design. This includes owner information, URLs for editing and viewing, and thumbnail information.
HTTP method and URL path
GET https://api.canva.com/rest/v1/designs/{designId}
This operation is rate limited to 100 requests per minute for each user of your integration.
Authentication and authorization
This endpoint requires a valid access token that acts on behalf of a user.
Scopes
The access token must have all the following scopes (permissions):
design:meta:read
Header parameters
Authorization``string
Required
Provides credentials to authenticate the request, in the form of a Bearer
token.
For example: Authorization: Bearer {token}
Path parameters
designId``string
Required
The design ID.
Example request
Examples for using the /v1/designs/{designId} endpoint:
cURLcURL
Node.jsNode.js
JavaJava
PythonPython
C#C#
GoGo
PHPPHP
RubyRuby
curl --request GET 'https://api.canva.com/rest/v1/designs/{designId}' \
--header 'Authorization: Bearer {token}'
SH
Copy
const fetch = require("node-fetch");
fetch("https://api.canva.com/rest/v1/designs/{designId}", {
method: "GET",
headers: {
"Authorization": "Bearer {token}",
},
})
.then(async (response) => {
const data = await response.json();
console.log(data);
})
.catch(err => console.error(err));
JS
Copy
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/designs/{designId}"))
.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
Copy
import requests
headers = {
"Authorization": "Bearer {token}"
}
response = requests.get("https://api.canva.com/rest/v1/designs/{designId}",
headers=headers
)
print(response.json())
PY
Copy
using System.Net.Http;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("https://api.canva.com/rest/v1/designs/{designId}"),
Headers =
{
{ "Authorization", "Bearer {token}" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
};
CSHARP
Copy
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.canva.com/rest/v1/designs/{designId}"
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
Copy
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.canva.com/rest/v1/designs/{designId}",
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
Copy
require 'net/http'
require 'uri'
url = URI('https://api.canva.com/rest/v1/designs/{designId}')
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
Copy
Success response
Expand all
If successful, the endpoint returns a 200 response with a JSON body with the
following parameters:
design``Design
The design object, which contains metadata about the design.
Properties of design
id``string
The design ID.
owner``TeamUserSummary
Metadata for the user, consisting of the User ID and Team ID.
Properties of owner
user_id``string
The ID of the user.
team_id``string
The ID of the user's Canva Team.
urls``DesignLinks
A temporary set of URLs for viewing or editing the design.
Properties of urls
edit_url``string
A temporary editing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.
This is not a permanent URL, it is only valid for 30 days.
view_url``string
A temporary viewing URL for the design. This URL is only accessible to the user that made the API request, and is designed to support return navigation workflows.
This is not a permanent URL, it is only valid for 30 days.
created_at``integer
When the design was created in Canva, as a Unix timestamp (in seconds since the Unix Epoch).
updated_at``integer
When the design was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).
title``string
Optional
The design title.
thumbnail``Thumbnail
Optional
A thumbnail image representing the object.
Properties of thumbnail
width``integer
The width of the thumbnail image in pixels.
height``integer
The height of the thumbnail image in pixels.
url``string
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_count``integer
Optional
The total number of pages in the design. Some design types don't have pages (for example, Canva docs).
Example response
{
"design": {
"id": "DAFVztcvd9z",
"title": "My summer holiday",
"owner": {
"user_id": "auDAbliZ2rQNNOsUl5OLu",
"team_id": "Oi2RJILTrKk0KRhRUZozX"
},
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
},
"urls": {
"edit_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/edit",
"view_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/view"
},
"created_at": 1377396000,
"updated_at": 1692928800,
"page_count": 5
}
}
JSON
Copy
Try it out
This uses your live Canva data.
This is not a sandbox/playground. This form performs API requests against your account's actual live Canva data. Make sure that you understand what the request is doing, as well as the requirements for each parameter detailed above.
Step 1: Enter your access token
To get started, generate an access token or provide your own below
Generate an access token
Access token
Community[Get Help](https://canva- external.atlassian.net/servicedesk/customer/portal/2/group/2)[GitHub](https://github.com/canva- sdks/canva-connect-api-starter-kit)
Was this page useful?YesNo
© 2025 All Rights Reserved. Canva®
[Privacy policy](https://www.canva.com/policies/privacy- policy/)Terms