Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Notion Pages API

Pages represent documents in Notion workspaces. They can exist as standalone pages or as entries within a database. Pages contain properties (metadata) and content composed of blocks. Use these endpoints to create, retrieve, update, archive, and manage page properties and content.

Notion Pages API is one of 6 APIs that Notion publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Pages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, authentication docs, a getting-started guide, and 3 JSON Schemas.

This API exposes 4 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.1.0, at version 2022-06-28.

Requests are made against a single base URL, https://api.notion.com/v1.

4 operations 3 paths 9 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2022-06-28
Server
https://api.notion.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Notion Pages API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Notion API uses bearer token authentication. Obtain an integration token from https://www.notion.so/my-integrations. Pass the token in the Authorization header…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Pages 4

Pages represent documents in Notion workspaces. They can exist as standalone pages or as entries within a database. Pages contain properties (metadata) and content composed of blo…

POST
/pages
Notion Create a page
createPage 1 param body → 200400401404429
GET
/pages/{page_id}
Notion Retrieve a page
retrievePage 3 params → 200401404429
PATCH
/pages/{page_id}
Notion Update page properties
updatePage 2 params body → 200400401404429
GET
/pages/{page_id}/properties/{property_id}
Notion Retrieve a page property item
retrievePageProperty 5 params → 200401404429

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Page (14 properties), Block (11 properties), RichText (7 properties), Parent (5 properties). Each schema is shown below with its type and property counts.

Emoji
object
An emoji icon object.
2 properties 2 required
File
object
A File object represents a file in Notion. Files can be either hosted by Notion (type "file") or externally hosted (type "external").
5 properties 1 required
Block
object
A Block object represents a piece of content within a Notion page. Blocks are the building blocks of all page content and can be of many types including paragr…
11 properties 6 required
Page
object
A Page object represents a page in a Notion workspace. Pages can exist as standalone pages in a workspace or as items within a database. Each page has properti…
14 properties 10 required
Parent
object
A Parent object represents the parent of a page, database, or block. The parent can be a workspace, page, database, or block.
5 properties 1 required
RichText
object
A Rich Text object represents styled text content in Notion. Rich text can include annotations like bold, italic, and color, as well as links and mentions of o…
7 properties 2 required
ExternalFile
object
An external file reference.
2 properties 2 required
PartialUser
object
A partial User object containing only the object type and ID. Used in createdby and lasteditedby fields.
2 properties 2 required
Error
object
An error response from the Notion API.
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

notion-pages-api-openapi.yml Raw ↑

Other APIs Notion publishes across the network.

Notion Blocks API
Notion Comments API
Notion Databases API
Notion Search API
Notion Users API