Designs

Overview Create design List designs Get design Get design pages Get design export formats

Get design pages

Get the metadata for pages in a design.

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

GET https://api.canva.com/rest/v1/designs/{designId}/pages

This operation is rate limited to 100 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:read

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

designIdstring

REQUIRED

The design ID.

Query parameters

offsetinteger

OPTIONAL

The page index to start the range of pages to return. Default is 1.

Pages are indexed using one-based numbering, so the first page in a design has the index value 1.

limitinteger

OPTIONAL

The number of pages to return, starting at the page index specified using the offset parameter. Default is 50 pages.

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());
    }
}

JAVA

import requests

headers = {
    "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);
};

CSHARP

package main

import (
	"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;
}

PHP

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 = 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:

itemsDesignPage[]

The list of pages.

Properties of items

indexinteger

The index of the page in the design. The first page in a design has the index value 1.

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.

Example response

{
  "items": [
    {
      "index": 0,
      "thumbnail": {
        "width": 595,
        "height": 335,
        "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
      }
    }
  ]
}

JSON

Get design pages

HTTP method and URL path

Authentication

Header parameters

Path parameters

Query parameters

Example request

Success response

Example response

Try it out

Step 1: Enter your access token