Get design pages

Get the metadata for pages in a design.

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.

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.

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.

#Authorizationstring
Required

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

For example: Authorization: Bearer {token}

#designIdstring
Required

The design ID.

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

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}'
sh

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.

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

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