Get design pages
This API is currently provided as a preview. Be aware of the following:
- There might be unannounced breaking changes.
- Any breaking changes to preview APIs won't produce a new API version.
- Public integrations that use preview APIs will not pass the review process, and can't be made available to all Canva users.
Lists metadata for pages in a design, such as page-specific thumbnails.
For the specified design, you can provide offset and limit values to specify the range of pages to return.
Some design types don't have pages (for example, Canva docs).
HTTP method and URL path
https://api.canva.com /rest /v1 /designs/{designId}/pagesThis 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:content:read
Header parameters
Path parameters
designIdstringThe design ID.
Query parameters
offsetintegerThe page index to start the range of pages to return.
Pages are indexed using one-based numbering, so the first page in a design has the index value 1.
Minimum: 1
Maximum: 500
Default value: 1
limitintegerThe number of pages to return, starting at the page index specified using the offset parameter.
Minimum: 1
Maximum: 200
Default value: 50
Example request
Examples for using the /v1/designs/{designId}/pages endpoint:
curl --request GET 'https://api.canva.com/rest/v1/designs/{designId}/pages' \--header 'Authorization: Bearer {token}'
const fetch = require("node-fetch");fetch("https://api.canva.com/rest/v1/designs/{designId}/pages", {method: "GET",headers: {"Authorization": "Bearer {token}",},}).then(async (response) => {const data = await response.json();console.log(data);}).catch(err => console.error(err));
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}/pages")).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());}}
import requestsheaders = {"Authorization": "Bearer {token}"}response = requests.get("https://api.canva.com/rest/v1/designs/{designId}/pages",headers=headers)print(response.json())
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}/pages"),Headers ={{ "Authorization", "Bearer {token}" },},};using (var response = await client.SendAsync(request)){response.EnsureSuccessStatusCode();var body = await response.Content.ReadAsStringAsync();Console.WriteLine(body);};
package mainimport ("fmt""io""net/http")func main() {url := "https://api.canva.com/rest/v1/designs/{designId}/pages"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))}
$curl = curl_init();curl_setopt_array($curl, array(CURLOPT_URL => "https://api.canva.com/rest/v1/designs/{designId}/pages",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;}
require 'net/http'require 'uri'url = URI('https://api.canva.com/rest/v1/designs/{designId}/pages')http = Net::HTTP.new(url.host, url.port)http.use_ssl = truerequest = Net::HTTP::Get.new(url)request['Authorization'] = 'Bearer {token}'response = http.request(request)puts response.read_body
Success response
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
itemsDesignPage[]The list of pages.
page_numberintegerThe 1-based page number within the design. The first page in a design has the value 1.
Minimum: 1
Maximum: 500
idstringThe ID of the page. This ID is unique within the design and can be used to correlate a page with per-page data from other APIs.
Some designs might not have page IDs, in which case this property is omitted.
dimensionsPageDimensionsThe dimensions of a design page, if it is bounded. Design pages for non-bounded designs like Whiteboards and Docs will not include this property.
widthnumberThe width of the design page in pixels.
heightnumberThe height of the design page in pixels.
thumbnailThumbnailA thumbnail image representing the object.
widthintegerThe width of the thumbnail image in pixels.
heightintegerThe height of the thumbnail image in pixels.
urlstringA 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.
design_typestringThis property is a preview feature. There might be unannounced breaking changes to this feature which won't produce a new API version.
The type of content a design or page contains. This is for responses and is separate from a request's PresetDesignTypeName. This list may be extended, so ensure values not listed here are handled.
Available values:
docemailpresentationsheetwhiteboardcustomunknown
indexintegerThis property is deprecated. Use page_number instead, which returns an identical value.
The index of the page in the design. The first page in a design has the index value 1.
Minimum: 1
Maximum: 500
Example response
{"items": [{"id": "PB2NFQ9W78kLDFCK","page_number": 1,"dimensions": {"width": 595,"height": 1295},"thumbnail": {"width": 595,"height": 335,"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"},"design_type": "presentation"}]}