Notion API

by notion.com

Overview

Integrate with Notion

Notion is a documents & productivity API from notion.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 13 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Documents & Productivity
Base URL: https://api.notion.com
Version: 1.0.0
Endpoints: 13
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.notion.com/v1/comments" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.notion.com/v1/comments", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.notion.com/v1/comments",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/v1/blocks/{id}`	Retrieve a block
PATCH	`/v1/blocks/{id}`	Update a block
DELETE	`/v1/blocks/{id}`	Delete a block
GET	`/v1/blocks/{id}/children`	Retrieve block children
PATCH	`/v1/blocks/{id}/children`	Append block children
GET	`/v1/comments`	Retrieve comments
GET	`/v1/databases/{id}`	Retrieve a database
PATCH	`/v1/databases/{id}`	Update a database
POST	`/v1/databases/{id}/query`	Query a database
GET	`/v1/pages/{id}`	Retrieve a Page
PATCH	`/v1/pages/{id}`	Update Page properties
GET	`/v1/pages/{page_id}/properties/{property_id}`	Retrieve a Page Property Item
GET	`/v1/users/{id}`	Retrieve a user