Developer API
V2

获取块子块

分页获取一个块下的直接子块列表。

GET /v2/blocks/:block_id/children

获取块子块

适用场景

当你需要分页获取一个块下的直接子块时,使用这个接口。它适合做大块内容的分段加载。

接口信息

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

权限要求

需要 blocks.read

请求参数

参数类型必填说明
block_idstring父 block ID。
start_cursorstring分页游标。
page_sizenumber继承统一分页逻辑,默认 20,最大 100

响应结果

{
  "object": "list",
  "results": [
    {
      "object": "block",
      "id": "12121212-1212-4212-8212-121212121212",
      "type": "heading_2"
    },
    {
      "object": "block",
      "id": "13131313-1313-4313-8313-131313131313",
      "type": "paragraph"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

行为说明

  • 这个接口只返回直接子块,不会自动展开孙子块。
  • next_cursor 是下一页游标,客户端应原样回传到 start_cursor 继续读取。
  • has_morefalse 时,next_cursornull

错误提示

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

相关文档

前置阅读

下一步

相关参考