Canva

列出文件夹项目

开发环境

GET

/rest/v1/folders/{folderId}/items

列出文件夹的内容。

此 API 目前以预览版形式提供。请注意以下事项：

可能会有未公布的重大变化。

对预览 API 的任何重大更改都不会产生新的API 版本。

使用预览 API 的公共集成将不会通过审核流程，并且无法向所有 Canva 用户提供。

列出文件夹中的项目，包括每个项目的type。

文件夹可以包含：

其他文件夹。

资产，例如上传的图像和视频。

设计，例如 Instagram 帖子、演示文稿和文档（Canva Docs）。

品牌模板。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/rest/v1/folders//items' \
--header 'Authorization: Bearer {token}'

响应示例

{
  "items": [
    {
      "type": "asset",
      "asset": {
        "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>"
        }
      }
    },
    {
      "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",
        "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/{token}/edit",
          "view_url": "https://www.canva.com/api/design/{token}/view"
        }
      }
    },
    {
      "type": "template",
      "template": {
        "id": "TEMzWSwy3BI",
        "title": "My posts template",
        "url": "https://www.canva.com/templates/EADao7wZnAA-black-white-simple-quote-instagram-post/",
        "thumbnails": [
          {
            "width": 595,
            "height": 335,
            "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
          }
        ]
      }
    }
  ],
  "continuation": "RkFGMgXlsVTDbMd:MR3L0QjiaUzycIAjx0yMyuNiV0OildoiOwL0x32G4NjNu4FwtAQNxowUQNMMYN"
}

请求参数

Path 参数

folderId

string

文件夹 ID。

必需

Header 参数

Authorization

string

必需

示例值:

Bearer {token}

返回响应

🟢200成功

application/json

Body

items

array [object {5}]

必需

type

string

必需

可以是下列之一： asset：有关资产的详细信息。 folder：有关文件夹的详细信息。 design：有关设计的详细信息。 template：有关模板的详细信息。

asset

object

可选

资产对象，包含有关资产的元数据。

folder

object

可选

文件夹对象，包含有关文件夹的元数据。

design

object

可选

设计对象，包含有关设计的元数据。

template

object

可选

模板对象，包含有关模板的元数据。

continuation

string

必需

如果成功响应包含继续标记，则文件夹包含更多可列出的项目。您可以将此标记用作查询参数并从列表中检索更多项目，例如 /v1/folders/{folderId}/items?continuation={continuation}。要检索文件夹中的所有项目，您可能需要发出多个请求。

修改于 2024-06-27 05:47:28

删除文件夹

移动文件夹项目