Sign in
design

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

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

Changed in 3 of the 8 revisions of this API.123

  • f32aa6ee029d4See the full diff
    • ●

      added the new design_generation_rejected enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new design_generation_rejected enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new design_generation_rejected enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new design_generation_rejected enum value to the code response property for the response status default

      response-property-enum-value-added

  • e5ffb199a5108See the full diff
    • ●

      added the new domain_restricted enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new domain_restricted enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new domain_restricted enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new domain_restricted enum value to the code response property for the response status default

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new user_already_member enum value to the code response property for the response status default

      response-property-enum-value-added

  • 9970f34a2be23See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added