Developer API
V2

获取块

获取单个 block 的元数据和类型展开内容。

GET /v2/blocks/:block_id

获取块

适用场景

当你要读取某个 block 的完整内容时使用这个接口。它会返回 block 的通用字段,并按 type 展开对应的内容字段。

接口信息

项目内容
方法GET
路径/v2/blocks/:block_id
请求体
返回block
Scopeblocks.read

权限要求

需要 blocks.read

请求参数

参数类型必填说明
block_idstringblock ID。

响应结果

{
  "object": "block",
  "id": "88888888-8888-4888-8888-888888888888",
  "type": "paragraph",
  "paragraph": {
    "rich_text": [
      {
        "type": "text",
        "text": {
          "content": "这里是一段正文内容。",
          "link": null
        },
        "plain_text": "这里是一段正文内容。",
        "href": null
      }
    ],
    "color": "default"
  }
}

行为说明

  • block 的内容字段会按 type 展开,只有对应类型的字段会出现在响应里。
  • 例如 type = paragraph 时返回 paragraph 字段,type = to_do 时返回 to_do 字段。
  • 如果要读取 block 的直接子块,请继续使用 block children 接口。

错误提示

  • 401 unauthorized:token 无效或已过期。
  • 403 forbidden:缺少 blocks.read 或无权访问该 block。
  • 404 not_found:block 不存在。

相关文档

前置阅读

下一步

相关参考