Developer API
V2

获取页面

获取单个页面的元数据和属性,不包含页面子块内容。

GET /v2/pages/:page_id

获取页面

适用场景

当你只需要读取页面本身的元数据、父级关系和属性值时使用这个接口。页面正文内容不在这里返回。

接口信息

项目内容
方法GET
路径/v2/pages/:page_id
请求体
返回page
Scopepages.read

权限要求

需要 pages.read

请求参数

参数类型必填说明
page_idstring页面 ID。

响应结果

{
  "object": "page",
  "id": "22222222-2222-4222-8222-222222222222",
  "page_type": "page",
  "parent": {
    "type": "page_id",
    "page_id": "55555555-5555-4555-8555-555555555555"
  },
  "properties": {
    "title": {
      "id": "title",
      "type": "title",
      "title": [
        {
          "type": "text",
          "text": {
            "content": "季度规划",
            "link": null
          },
          "plain_text": "季度规划",
          "href": null
        }
      ]
    }
  }
}

行为说明

  • 这个接口只返回页面元数据和属性,不返回子块。
  • 如果要读取页面正文,请继续使用 block 相关接口。
  • 页面属于数据库时,返回的属性值会按数据库 schema 对应到页面属性。

错误提示

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

相关文档

前置阅读

下一步

相关参考