List folder items with the Canva API
Lists the folders, designs and images in a folder, each with its type, the folder, design or image object and its id. Video assets are not listed. When the response has continuation, pass it as continuation to read the next page.
- Identifier
- canva_list_folder_items
The request
POST https://connect.reportei.com/api/tools/canva_list_folder_items/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"folderId": "<folderId>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| folderId | string | Yes | root for the top level of the projects, uploads for the Uploads folder, or the id of a folder listed by List folder items. |
| item_types | string | No | Comma-separated types to list, among design, folder and image, like design,image. All three by default. |
| sort_by | string | No | Order of the items. The default is modified_descending.Values: created_ascending, created_descending, modified_ascending, modified_descending, title_ascending, title_descending |
| limit | integer | No | Items per page, up to 100. The default is 50. |
| continuation | string | No | The continuation of the previous response. |
Supported connections
Your customer connects their Canva account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/canva, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/canva_list_folder_items. It becomes your agent's tool definition with no conversion.
Other Canva tools
- List designsGETLists the designs in the projects of the user and the ones shared with them, with id, title, thumbnail, page_count and the edit and view urls. When the response has continuation, pass it as continuation to read the next page.
- Get designGETReturns a design with its title, owner, thumbnail, page_count and the edit and view urls. Those urls are temporary and open only for the connected user.
- Create designPOSTCreates a design and returns it with its id and the edit and view urls. Send design_type, asset_id or both. A blank design that nobody edits within 7 days is deleted for good, without going to the trash.
- List design export formatsGETLists the formats a design can be exported to, which depend on its type and pages. A format with page_numbers works only for those pages.
- Create design exportPOSTStarts exporting a design as PDF, JPG, PNG, PPTX or GIF and returns the job with its id. Call Get design export until status is success: the urls of the files are valid for 24 hours. Each user can export 75 times every 5 minutes and 500 times a day.
- Create design video exportPOSTStarts exporting a design as an MP4 video and returns the job with its id. Call Get design export until status is success: the urls of the files are valid for 24 hours. Each user can export 75 times every 5 minutes and 500 times a day.
- Get design exportGETReturns an export job: status in_progress, success or failed, and, with success, the urls of the files, one per page depending on the format, valid for 24 hours. Call it again, with growing waits, while status is in_progress.
- Get assetGETReturns an asset with its name, tags, thumbnail, owner and dates.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
