List folder items

List the contents of a folder.

Lists the items in a folder, including each item's type.

Folders can contain:

  • Other folders.
  • Designs, such as Instagram posts, Presentations, and Documents (Canva Docs).
  • Image assets.
GET https://api.canva.com/rest/v1/folders/{folderId}/items

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

  • folder: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}

#folderIdstring
Required

The folder ID.

#continuationstring
Optional

If the success response contains a continuation token, the folder contains more items you can list. You can use this token as a query parameter and retrieve more items from the list, for example /v1/folders/{folderId}/items?continuation={continuation}.

To retrieve all the items in a folder, you might need to make multiple requests.

#item_typesstring[]
Optional

Filter the folder items to only return specified types. The available types are: design, folder, and image. To filter for more than one item type, provide a comma- delimited list.

#sort_bystring
Optional

Sort the list of folder items. This can be one of the following:

  • created_ascending: Sort results by creation date, in ascending order.
  • created_descending: Sort results by creation date, in descending order.
  • modified_ascending: Sort results by the last modified date, in ascending order.
  • modified_descending: (Default) Sort results by the last modified date, in descending order.
  • title_ascending: Sort results by title, in ascending order. The title is either the name field for a folder or asset, or the title field for a design.
  • title_descending: Sort results by title, in descending order. The title is either the name field for a folder or asset, or the title field for a design.

Examples for using the /v1/folders/{folderId}/items endpoint:

curl --request GET 'https://api.canva.com/rest/v1/folders/{folderId}/items' \
--header 'Authorization: Bearer {token}'
sh

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

#itemsFolderItemSummary[]

An array of items in the folder.

Properties of items
#typestring

This can be one of the following:

  • folder: Details about the folder.
  • design: Details about the design.
  • image: Details about the image asset.
#folderFolder
Conditional

The folder object, which contains metadata about the folder.

Properties of folder
#idstring

The folder ID.

#namestring

The folder name.

#created_atinteger

When the folder was created, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the folder was last updated, as a Unix timestamp (in seconds since the Unix Epoch).

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

#designDesignSummary
Conditional

Basic details about the design, such as the design's ID, title, and URL.

Properties of design
#idstring

The design ID.

#urlsDesignLinks

A temporary set of URLs for viewing or editing the design.

Properties of urls
#edit_urlstring

A temporary editing URL for the design.

#view_urlstring

A temporary viewing URL for the design.

#created_atinteger

When the design was created in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the design was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#titlestring
Optional

The design title.

#urlstring
Optional

URL of the design.

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

#page_countinteger
Optional

The total number of pages in the design. Some design types don't have pages (for example, Canva docs).

#imageAssetSummary
Conditional

An object representing an asset with associated metadata.

Properties of image
#typestring

Type of an asset. Currently, this only supports image assets. Support for video assets is coming in the future.

#idstring

The ID of the asset.

#namestring

The name of the asset.

#tagsstring[]

The user-facing tags attached to the asset. Users can add these tags to their uploaded assets, and they can search their uploaded assets in the Canva UI by searching for these tags. For information on how users use tags, see the Canva Help Center page on asset tags.

#created_atinteger

When the asset was added to Canva, as a Unix timestamp (in seconds since the Unix Epoch).

#updated_atinteger

When the asset was last updated in Canva, as a Unix timestamp (in seconds since the Unix Epoch).

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

#continuationstring
Optional

If the success response contains a continuation token, the folder contains more items you can list. You can use this token as a query parameter and retrieve more items from the list, for example /v1/folders/{folderId}/items?continuation={continuation}.

To retrieve all the items in a folder, you might need to make multiple requests.

{
"items": [
{
"type": "folder",
"folder": {
"id": "FAF2lZtloor",
"name": "My awesome holiday",
"created_at": 1377396000,
"updated_at": 1692928800,
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
}
}
},
{
"type": "design",
"design": {
"id": "DAFVztcvd9z",
"title": "My summer holiday",
"url": "https://www.canva.com/design/DAFVztcvd9z/edit",
"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/{token}/edit",
"view_url": "https://www.canva.com/api/design/{token}/view"
},
"created_at": 1377396000,
"updated_at": 1692928800,
"page_count": 3
}
},
{
"type": "image",
"image": {
"type": "image",
"id": "Msd59349ff",
"name": "My Awesome Upload",
"tags": [
"image",
"holiday",
"best day ever"
],
"created_at": 1377396000,
"updated_at": 1692928800,
"thumbnail": {
"width": 595,
"height": 335,
"url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
}
}
}
],
"continuation": "RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN"
}
json

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