Skip navigation

Skip to main content

[](https://www.canva.com/developers/)

  * [Home](/)

  * Documentation

  * Blogs

  * [Your apps](https://www.canva.com/developers/apps)

  * [Your integrations](https://www.canva.com/developers/integrations)

Designs

[Overview](/docs/connect/api-reference/designs/)[Create
design](/docs/connect/api-reference/designs/create-design/)[List
designs](/docs/connect/api-reference/designs/list-designs/)[Get
design](/docs/connect/api-reference/designs/get-design/)[Get design
pages](/docs/connect/api-reference/designs/get-design-pages/)[Get design
export formats](/docs/connect/api-reference/designs/get-design-export-
formats/)

[Designs](/docs/connect/api-reference/designs/)

# Get design pages

Get the metadata for pages in a design.

Copy page

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](/docs/connect/versions/).
  * 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 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](/docs/connect/appendix/scopes/) (permissions):

  * `design:content: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.

## Query parameters

`offset``integer`

Optional

The 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`

`limit``integer`

Optional

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

cURLcURL

Node.jsNode.js

JavaJava

PythonPython

C#C#

GoGo

PHPPHP

RubyRuby

    
    
    curl --request GET 'https://api.canva.com/rest/v1/designs/{designId}/pages' \
    
    --header 'Authorization: Bearer {token}'

SH

Copy

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

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}/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

Copy

    
    
    import requests
    
    
    
    
    headers = {
    
        "Authorization": "Bearer {token}"
    
    }
    
    
    
    
    response = requests.get("https://api.canva.com/rest/v1/designs/{designId}/pages",
    
        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}/pages"),
    
      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}/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))
    
    }

GO

Copy

    
    
    $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

Copy

    
    
    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

Copy

## Success response

Expand all

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

`items``DesignPage[]`

The list of pages.

Properties of **items**

`index``integer`

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

**Minimum:** `1`

**Maximum:** `500`

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

## 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

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](https://community.canva.dev/)[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](https://www.canva.com/policies/)

[](https://www.facebook.com/canva)[](https://x.com/canva)[](https://www.pinterest.com/canva)[](https://instagram.com/canva)