Installation

Install the Notion SDK for JavaScript and get started with your integration

Package Manager

Install the @notionhq/client package using your preferred package manager:

npm

npm install @notionhq/client

yarn add @notionhq/client

pnpm add @notionhq/client

Requirements

The Notion SDK has the following minimum version requirements:

Runtime

• Node.js: >= 18

The SDK is designed for Node.js environments and leverages modern JavaScript features available in Node 18 and later.

Node.js versions below 18 are not supported. Upgrade to Node.js 18 or later for compatibility.

TypeScript (Optional)

• TypeScript: >= 5.9

If you’re using TypeScript in your project, version 5.9 or later is recommended for full type definition support.

The SDK includes comprehensive TypeScript definitions out of the box. No additional @types packages are required.

Version Compatibility

Different versions of the Notion SDK are designed to work with specific Notion API versions:

SDK Version	Minimum Recommended API Version
v4.0.0 and above	2022-06-28
v5.0.0 and above	2025-09-03

The SDK automatically uses the latest supported API version (2025-09-03 for v5.x). You can override this by passing a notionVersion option when creating the client.

Verify Installation

After installation, verify that the package is properly installed by importing it in your project:

CommonJS

const { Client } = require("@notionhq/client")

console.log("Notion SDK installed successfully!")

import { Client } from "@notionhq/client"

console.log("Notion SDK installed successfully!")

import { Client } from "@notionhq/client"

const client: Client = new Client()
console.log("Notion SDK installed successfully!")

Next Steps

Quickstart

Learn how to initialize the client and make your first API call

Authentication

Set up authentication with integration tokens or OAuth