该参考文档是深入了解 Notion API 的关键。

通过 API，集成可以访问 Notion 的页面、数据库和用户。集成可以将服务连接到 Notion 并为用户构建交互式体验。使用左侧的导航，您将找到 API 中使用的对象和端点的详细信息。

与 Notion API 交互需要一个集成令牌。在集成设置页面上创建集成后，您可以找到一个集成令牌。如果这是您第一次了解 Notion API，则建议从入门指南开始学习如何创建集成。

如果您想要处理特定的集成，但无法访问令牌，请确认您是否是相关工作区的管理员。您可以通过左侧侧边栏的“设置和成员”内部在 Notion UI 中进行检查。如果您在任何工作区中都不是管理员，则可以免费创建一个个人工作区。

约定

发送所有 API 请求的基本 URL 是 https://api.notion.com。所有 API 请求都需要 HTTPS。

Notion API 尽可能地遵循 RESTful 约定，大多数操作通过页面和数据库资源的 GET、POST、PATCH 和 DELETE 请求执行。请求和响应正文都编码为 JSON。

JSON 约定

• 顶级资源具有 "object" 属性。此属性可用于确定资源的类型（例如 "database"、"user"` 等）。
• 可通过 UUIDv4 "id" 属性对顶级资源进行寻址。在进行 API 请求时，您可以从 Notion URL 中复制 ID 时省略破折号。
• 属性名称采用 snake_case（而不是 camelCase 或 kebab-case）。
• Notion API 不支持空字符串。例如，对于像 url Property value object 这样的属性值，要取消设置字符串值，必须使用明确的 null，而不是 ""。

代码示例和 SDK

为每个端点显示了示例请求和响应。请求使用 Notion JavaScript SDK 和 cURL 进行显示。这些示例使您能够轻松地复制、粘贴和修改，以便在构建集成时使用。

Notion SDK 是可以安装的开源项目，可轻松开始构建。您也可以选择允许您进行 HTTP 请求的任何其他语言或库。

分页

返回对象列表的端点支持基于光标的分页请求。默认情况下，Notion 每个 API 调用返回十个项目。如果来自支持端点的响应中的项目数超过默认值，则集成可以使用分页请求请求特定的结果集和/或限制返回的项目数。

支持的端点