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>

AVAILABILITY: This API is only available to Print Partners.

Gets the metadata for a design. This includes owner information, URLs for editing and viewing, and thumbnail information.

Print partner proofing information (such as bleed and page constraints) isn't stored on Canva, so you can optionally provide it in the request. The design URLs that are returned include this information, which Canva applies in the editor when opening the design.

get/v1/print-partner/designs/{designId}

Request

  • Base URL: https://api.canva.com/rest
  • URL: https://api.canva.com/rest/v1/print-partner/designs/{designId}
  • 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:meta:read)

Path parameters

designIdstring required

The design ID.

Query parameters

bleedinteger

Bleed in microns to apply around the design in the editor. Bleed is the area outside the trim line used to avoid white edges after cutting. Use 0 for no bleed. If bleed is not specified, a default of 3000 microns is used.

min_pagesinteger

Minimum number of pages the design must have in the editor. The user cannot reduce the page count below this value. If both min_pages and max_pages are provided, min_pages must be less than or equal to max_pages.

max_pagesinteger

Maximum number of pages the design can have in the editor. The user cannot add pages beyond this value. If both min_pages and max_pages are provided, min_pages must be less than or equal to max_pages.

Response

OK

Example response

{
  "design": {
    "id": "DAFVztcvd9z",
    "title": "My summer holiday",
    "owner": {
      "user_id": "auDAbliZ2rQNNOsUl5OLu",
      "team_id": "Oi2RJILTrKk0KRhRUZozX"
    },
    "thumbnail": {
      "width": 595,
      "height": 335,
      "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
    },
    "urls": {
      "edit_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/edit",
      "view_url": "https://www.canva.com/api/design/eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiZXhwaXJ5IjoxNzQyMDk5NDAzMDc5fQ..GKLx2hrJa3wSSDKQ.hk3HA59qJyxehR-ejzt2DThBW0cbRdMBz7Fb5uCpwD-4o485pCf4kcXt_ypUYX0qMHVeZ131YvfwGPIhbk-C245D8c12IIJSDbZUZTS7WiCOJZQ.sNz3mPSQxsETBvl_-upMYA/view"
    },
    "created_at": 1377396000,
    "updated_at": 1692928800,
    "page_count": 5,
    "design_types": [
      "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

  • 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