design

Changed on
<Warning>

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 apps that use preview APIs will not pass the review process, and can't be made available to all Canva users.
</Warning>

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.

NOTE: Some design types don't have pages (for example, Canva docs).

get/v1/designs/{designId}/pages

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/designs/{designId}/pages
  • Auth: OAuth 2 (authorization code, authorization URL https://www.canva.com/api/oauth/authorize, token URL https://api.canva.com/rest/v1/oauth/token, scopes: design:content:read)

Path parameters

designIdstring required

The design ID.

Query parameters

offsetinteger

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.

limitinteger

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

Response

OK

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"
    }
  ]
}

Changes

  • 40ca7f6a753bRevision changes
    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

    • warning

      added the new user_linked_to_another_idp enum value to the response property for the response status

  • 5ea5a3f48e72Revision changes
    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status

    • warning

      added the new asset_not_ready enum value to the response property for the response status