文档与知识管理 / Notion API

Notion 数据 API

通过 Notion REST API 读取与编辑已获授权的页面、块、数据库、数据源、文件和评论,并用 Webhook 同步变更。个人脚本、团队内部自动化和面向多用户的应用应分别选择 PAT、内部连接或公开 OAuth 连接。本条目聚焦数据 API。

页面与块数据库数据源知识库同步文件Webhook
01 / CAPABILITIES

开放功能

核心接口调用手册

3 个场景

以 2026-03-11 API 版本,整理页面创建、正文读写、数据源查询 3 个场景;不覆盖模板、文件上传或 Markdown 预览功能。

页面与内容块

读取页面属性和内容块,创建页面、追加内容并修改已有内容,适合知识库同步和自动归档。

接入要求内容读取、更新和新增是不同权限;内部连接还需页面授权,PAT 则依赖创建者现有权限。
在已授权页面下新建页面站内调用手册 · 参数、代码与排错读取页面正文并追加段落站内调用手册 · 参数、代码与排错

文件与媒体附件

上传文件,并将文件或媒体附到页面、内容块及支持的数据库属性中。

接入要求需遵守上传流程、支持的文件格式与工作区文件限制;下载链接和文件对象按官方说明处理。

页面与讨论评论

读取页面或块上的评论,向页面或已有讨论添加评论,为审阅及协作工具提供入口。

接入要求Read comments 与 Insert comments 分开授权;评论权限不能替代对应页面的访问权限。

内容变更通知

订阅页面、数据库等支持的变更事件,触发外部同步任务。

接入要求在连接设置中配置公网 HTTPS Webhook 并完成验证;事件通常携带资源 ID,应用再调用 API 获取最新内容。
02 / REQUIREMENTS

接入条件

适用主体
个人知识库工具开发者、团队自动化开发者、Notion 集成产品开发者
接入方式
用户级个人访问 Token(PAT) / 单工作区内部连接 API Token / 公开连接 OAuth 2.0 / 连接 Webhook 事件通知
申请概况
个人可用 PAT;团队连接和公开应用按工作区角色、资源权限与授权方式接入。
  • 先选择个人脚本、团队自动化或多用户产品:PAT 代表创建者,内部连接作为独立 bot,公开产品使用 OAuth。
  • 创建内部连接需要工作区所有者身份;PAT 仅供完整工作区成员创建,并受套餐默认策略与管理员设置约束。
  • 创建凭证后仍需授予内容及操作权限;内部连接要明确共享页面或数据库,公开连接由用户在 OAuth 中选择可共享内容。
  • REST 请求使用 Bearer Token,并指定 Notion-Version;上线前按当前版本核对数据库、数据源和分页行为。
03 / GET STARTED

开通步骤

  1. 01

    确定连接类型

    个人工具选 PAT;团队共有自动化选内部连接;需要其他用户安装时选公开 OAuth 连接。

  2. 02

    在 Notion 中配置凭证

    按官方入门和开发者模式说明进入 Developer portal,创建凭证并选择必要能力。

  3. 03

    授予测试内容权限

    准备自己的测试页面与数据库,再按所选连接类型授权;不要把能创建 Token 等同于已能读写全部工作区。

  4. 04

    验证内容与事件流程

    先做少量读取和创建,确认分页、错误处理及实际内容;使用 Webhook 时再验证回调和重复事件处理。

04 / COSTS & LIMITS

费用、边界与测试方式

费用概况

工作区有免费与按成员订阅的套餐,API 频控及部分内容限制随方案变化。

  • 官方套餐以每成员、每月为主要订阅单位;月付与年付、币种及地区会影响显示金额。
  • 数据 API 的请求额度按连接、工作区及端点计算;当前请求限制页按工作区套餐划分频控,没有列按返回字符或 Token 消耗的计价表。
  • Free 工作区可用于入门;多人工作区的终身块限制对特定连接生效,达到限制后部分创建请求会失败,删除块不恢复容量。
  • 文件上传受套餐文件大小限制;Workers 与 Custom Agents 的 credits 属于其他开发者产品,不能将其费用直接套用于本条目数据请求。

使用范围与限制

  • PAT 不能代表整个组织,创建者失去页面或工作区权限时,PAT 也失去相应访问;PAT 不支持列出全部工作区用户。
  • 内部连接、公开 OAuth 和 PAT 的内容授权机制不同,不应把共享给 bot 的步骤照搬到 PAT。
  • 多人 Free 工作区的块上限可阻止部分连接继续创建内容;具体适用范围不同,不能概括为所有 API 写入均无限。
  • 请求受连接、工作区和端点频控,以及负载大小和嵌套深度限制;出现 429 或 529 时处理 Retry-After。
  • 写入返回 503 时可能已经保存,应先检查响应中的重试指引与资源现状,避免重复创建。
  • 本条目不覆盖 Notion Agent、Workers 执行或 Enterprise Admin API 的独立资格和计费。

如何进行开发测试

  • 正式 REST API:在选定工作区对实际页面和数据库生效。
  • 开发验证:使用独立测试页面、数据库或工作区,并按官方 quickstart 创建测试用凭证。
  • Webhook 测试:官方提供修改页面标题等测试步骤及签名验证示例,仍操作实际获授权内容;本次没有执行。
  • 本次未确认与正式数据自动隔离的通用沙箱,不将测试凭证视为不会修改实际内容的保证。

接入前再确认

  • 按当前 2026-03-11 文档与 PAT 规则整理;未创建 Token、连接或测试页面。
  • 当前帮助页与开发者文档均将入口称为 Developer portal;本页提供官方配置说明,没有把旧后台地址当作已核验的新入口。
  • 未确认独立 REST 按次收费表;已明确工作区订阅、频控、文件与块限制,未作全产品免费承诺。
05 / OFFICIAL SOURCES

官方资料

以下资料用于核对本页内容。申请与使用时,请以对应接口的最新规则为准。

  1. 01
    Notion 数据 API 与连接类型概览已核对官方资料 · 2026-10-15
  2. 02
    REST 请求、版本与分页约定已核对官方资料 · 2026-10-15
  3. 03
    内部连接与公开 OAuth 授权已核对官方资料 · 2026-10-15
  4. 04
    PAT 创建资格、权限与工作区策略已核对官方资料 · 2026-10-15
  5. 05
    内容、评论与用户信息权限已核对官方资料 · 2026-10-15
  6. 06
    文件与媒体接入已核对官方资料 · 2026-10-15
  7. 07
    连接 Webhook 设置、验证与测试已核对官方资料 · 2026-10-15
  8. 08
    请求频控、大小限制与重试已核对官方资料 · 2026-10-15
  9. 09
    Free 工作区块限制及适用连接已核对官方资料 · 2026-10-15
  10. 10
    工作区套餐与开发者功能已核对官方资料 · 2026-10-15
  11. 11
    使用 PAT 创建页面的官方入门已核对官方资料 · 2026-10-15
  12. 12
    Notion 工作区内开发者模式与连接管理已核对官方资料 · 2026-10-15
官方文档核对,未进行接口实测
最近核验 2026-10-15 · 查看核验说明