\t
Notion SDK for JavaScript
\t
\t\tA simple and easy to use client for the Notion API \t
\t
\t
\t
![\"Notion](\"https://www.notion.so/images/notion-logo-block-main.svg\"){kind=logo}
\n\n**A simple and easy to use client for the [Notion API](https://developers.notion.com).**\n\n\n[](https://www.npmjs.com/package/@notionhq/client)\n\n## Installation\n\n```bash\nnpm install @notionhq/client\n```\n\n[](https://www.val.town/v/charmaine/NotionJsSDK)\n\n## Usage\n\n> [!NOTE]\n> Use Notion's [Getting Started Guide](https://developers.notion.com/docs/getting-started) to get set up to use Notion's API.\n\nImport and initialize a client using an **integration token** or an OAuth **access token**.\n\n```js\nconst { Client } = require(\"@notionhq/client\")\n\n// Initializing a client\nconst notion = new Client({\n auth: process.env.NOTION_TOKEN,\n})\n```\n\nMake a request to any Notion API endpoint.\n\n```js\n;(async () => {\n const listUsersResponse = await notion.users.list({})\n})()\n```\n\n> [!NOTE]\n> See the complete list of endpoints in the [API reference](https://developers.notion.com/reference).\n\nEach method returns a `Promise` that resolves the response.\n\n```js\nconsole.log(listUsersResponse)\n```\n\n```ts\n{\n results: [\n {\n object: \"user\",\n id: \"d40e767c-d7af-4b18-a86d-55c61f1e39a4\",\n type: \"person\",\n person: {\n email: \"avo@example.org\",\n },\n name: \"Avocado Lovelace\",\n avatar_url:\n \"https://secure.notion-static.com/e6a352a8-8381-44d0-a1dc-9ed80e62b53d.jpg\",\n },\n // ...\n ]\n}\n```\n\nEndpoint parameters are grouped into a single object. You don't need to remember which parameters go in the path, query, or body.\n\n```js\nconst myPage = await notion.dataSources.query({\n data_source_id: \"897e5a76-ae52-4b48-9fdf-e71f5945d1af\",\n filter: {\n property: \"Landmark\",\n rich_text: {\n contains: \"Bridge\",\n },\n },\n})\n```\n\n### Handling errors\n\nIf the API returns an unsuccessful response, the returned `Promise` rejects with a `APIResponseError`.\n\nThe error contains properties from the response, and the most helpful is `code`. You can compare `code` to the values in the `APIErrorCode` object to avoid misspelling error codes.\n\n```js\nconst { Client, APIErrorCode } = require(\"@notionhq/client\")\n\ntry {\n const notion = new Client({ auth: process.env.NOTION_TOKEN })\n const myPage = await notion.dataSources.query({\n data_source_id: dataSourceId,\n filter: {\n property: \"Landmark\",\n rich_text: {\n contains: \"Bridge\",\n },\n },\n })\n} catch (error) {\n if (error.code === APIErrorCode.ObjectNotFound) {\n //\n // For example: handle by asking the user to select a different data source\n //\n } else {\n // Other error handling code\n console.error(error)\n }\n}\n```\n\n### Logging\n\nThe client emits useful information to a logger. By default, it only emits warnings and errors.\n\nIf you're debugging an application, and would like the client to log response bodies, set the `logLevel` option to `LogLevel.DEBUG`.\n\n```js\nconst { Client, LogLevel } = require(\"@notionhq/client\")\n\nconst notion = new Client({\n auth: process.env.NOTION_TOKEN,\n logLevel: LogLevel.DEBUG,\n})\n```\n\nYou may also set a custom `logger` to emit logs to a destination other than `stdout`. A custom logger is a function which is called with 3 parameters: `logLevel`, `message`, and `extraInfo`. The custom logger should not return a value.\n\n### Client options\n\nThe `Client` supports the following options on initialization. These options are all keys in the single constructor parameter.\n\n| Option | Default value | Type | Description |\n| ----------- | --------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `auth` | `undefined` | `string` | Bearer token for authentication. If left undefined, the `auth` parameter should be set on each request. |\n| `logLevel` | `LogLevel.WARN` | `LogLevel` | Verbosity of logs the instance will produce. By default, logs are written to `stdout`. |\n| `timeoutMs` | `DEFAULT_TIMEOUT_MS` | `number` | Number of milliseconds to wait before emitting a `RequestTimeoutError` |\n| `baseUrl` | `DEFAULT_BASE_URL` | `string` | The root URL for sending API requests. This can be changed to test with a mock server. |\n| `logger` | Log to console | `Logger` | A custom logging function. This function is only called when the client emits a log that is equal or greater severity than `logLevel`. |\n| `agent` | Default node agent | `http.Agent` | Used to control creation of TCP sockets. A common use is to proxy requests with [`https-proxy-agent`](https://github.com/TooTallNate/node-https-proxy-agent) |\n| `retry` | See [constants](#constants) | `RetryOptions` | Configuration for automatic retries on rate limits (429) and server errors (500, 503). See [Automatic retries](#automatic-retries) below. |\n\n### Automatic retries\n\nThe client automatically retries requests that fail due to rate limiting or transient server errors. By default, it will retry up to 2 times using exponential back-off with jitter.\n\n**Retryable errors:**\n\n- `rate_limited` (HTTP 429) - Too many requests; retried for all HTTP methods\n- `internal_server_error` (HTTP 500) - Server error; retried only for GET and DELETE\n- `service_unavailable` (HTTP 503) - Service temporarily unavailable; retried only for GET and DELETE\n\nServer errors (500, 503) are only retried for idempotent HTTP methods (GET, DELETE) to avoid duplicate side effects. Rate limits (429) are retried for all methods since the server explicitly asks clients to retry.\n\n**Retry behavior:**\n\n- Uses exponential back-off: delays increase with each retry attempt\n- Respects the `Retry-After` header when present (both delta-seconds and HTTP-date formats)\n- Adds random jitter to prevent thundering herd problems\n\n**Configuration:**\n\n```js\nconst notion = new Client({\n auth: process.env.NOTION_TOKEN,\n retry: {\n maxRetries: 5, // Maximum retry attempts (default: 2)\n initialRetryDelayMs: 500, // Initial delay between retries (default: 1000ms)\n maxRetryDelayMs: 60000, // Maximum delay between retries (default: 60000ms)\n },\n})\n```\n\nTo disable automatic retries:\n\n```js\nconst notion = new Client({\n auth: process.env.NOTION_TOKEN,\n retry: false,\n})\n```\n\n### Constants\n\nThe SDK exports named constants for all default values used by the client, as well as useful Notion-specific values. You can import them directly:\n\n```js\nconst {\n DEFAULT_BASE_URL, // \"https://api.notion.com\"\n DEFAULT_TIMEOUT_MS, // 60_000\n DEFAULT_MAX_RETRIES, // 2\n DEFAULT_INITIAL_RETRY_DELAY_MS, // 1_000\n DEFAULT_MAX_RETRY_DELAY_MS, // 60_000\n MIN_VIEW_COLUMN_WIDTH, // 32\n} = require(\"@notionhq/client\")\n```\n\n`MIN_VIEW_COLUMN_WIDTH` is the minimum width (in pixels) that a table column can have in the Notion UI. Set a property's `width` to this value when creating or updating a view to make a column appear collapsed -- useful for checkbox or status-as-checkbox columns:\n\n```js\nawait notion.views.create({\n database_id: databaseId,\n name: \"My view\",\n type: \"table\",\n configuration: {\n table: {\n properties: [\n {\n property_id: checkboxPropId,\n visible: true,\n width: MIN_VIEW_COLUMN_WIDTH,\n },\n ],\n },\n },\n})\n```\n\n### TypeScript\n\nThis package contains type definitions for all request parameters and responses,\nas well as some useful sub-objects from those entities.\n\nBecause errors in TypeScript start with type `any` or `unknown`, you should use\nthe `isNotionClientError` type guard to handle them in a type-safe way. Each\n`NotionClientError` type is uniquely identified by its `error.code`. Codes in\nthe `APIErrorCode` enum are returned from the server. Codes in the\n`ClientErrorCode` enum are produced on the client.\n\n```ts\ntry {\n const response = await notion.dataSources.query({\n /* ... */\n })\n} catch (error: unknown) {\n if (isNotionClientError(error)) {\n // error is now strongly typed to NotionClientError\n switch (error.code) {\n case ClientErrorCode.RequestTimeout:\n // ...\n break\n case APIErrorCode.ObjectNotFound:\n // ...\n break\n case APIErrorCode.Unauthorized:\n // ...\n break\n // ...\n default:\n // you could even take advantage of exhaustiveness checking\n assertNever(error.code)\n }\n }\n}\n```\n\n#### Type guards\n\nThere are several [type guards](https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-guards-and-differentiating-types)\nprovided to distinguish between full and partial API responses.\n\n| Type guard function | Purpose |\n| ------------------------ | ---------------------------------------------------------------------------------------- |\n| `isFullPage` | Determine whether an object is a full `PageObjectResponse` |\n| `isFullBlock` | Determine whether an object is a full `BlockObjectResponse` |\n| `isFullDataSource` | Determine whether an object is a full `DataSourceObjectResponse` |\n| `isFullPageOrDataSource` | Determine whether an object is a full `PageObjectResponse` or `DataSourceObjectResponse` |\n| `isFullUser` | Determine whether an object is a full `UserObjectResponse` |\n| `isFullComment` | Determine whether an object is a full `CommentObjectResponse` |\n\nHere is an example of using a type guard:\n\n```typescript\nconst fullOrPartialPages = await notion.dataSources.query({\n data_source_id: \"897e5a76-ae52-4b48-9fdf-e71f5945d1af\",\n})\nfor (const page of fullOrPartialPages.results) {\n if (!isFullPageOrDataSource(page)) {\n continue\n }\n // The page variable has been narrowed from\n // PageObjectResponse | PartialPageObjectResponse | DataSourceObjectResponse | PartialDataSourceObjectResponse\n // to\n // PageObjectResponse | DataSourceObjectResponse.\n console.log(\"Created at:\", page.created_time)\n}\n```\n\n### Utility functions\n\nThis package also exports a few utility functions that are helpful for dealing with\nany of our paginated APIs.\n\n#### `iteratePaginatedAPI(listFn, firstPageArgs)`\n\nThis utility turns any paginated API into an async iterator.\n\n**Parameters:**\n\n- `listFn`: Any function on the Notion client that represents a paginated API (i.e. accepts\n `start_cursor`.) Example: `notion.blocks.children.list`.\n- `firstPageArgs`: Arguments that should be passed to the API on the first and subsequent calls\n to the API, for example a `block_id`.\n\n**Returns:**\n\nAn [async iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols)\nover results from the API.\n\n**Example:**\n\n```javascript\nfor await (const block of iteratePaginatedAPI(notion.blocks.children.list, {\n block_id: parentBlockId,\n})) {\n // Do something with block.\n}\n```\n\n#### `collectPaginatedAPI(listFn, firstPageArgs)`\n\nThis utility accepts the same arguments as `iteratePaginatedAPI`, but collects\nthe results into an in-memory array.\n\nBefore using this utility, check that the data you are dealing with is\nsmall enough to fit in memory.\n\n**Parameters:**\n\n- `listFn`: Any function on the Notion client that represents a paginated API (i.e. accepts\n `start_cursor`.) Example: `notion.blocks.children.list`.\n- `firstPageArgs`: Arguments that should be passed to the API on the first and subsequent calls\n to the API, for example a `block_id`.\n\n**Returns:**\n\nAn array with results from the API.\n\n**Example:**\n\n```javascript\nconst blocks = await collectPaginatedAPI(notion.blocks.children.list, {\n block_id: parentBlockId,\n})\n// Do something with blocks.\n```\n\n### Custom requests\n\nTo make requests directly to a Notion API endpoint instead of using the pre-built families of methods, call the `request()` method. For example:\n\n```ts\n// POST /v1/comments\nconst response = await notion.request({\n path: \"comments\",\n method: \"post\",\n body: {\n parent: { page_id: \"5c6a28216bb14a7eb6e1c50111515c3d\" },\n rich_text: [{ text: { content: \"Hello, world!\" } }],\n },\n // No `query` params in this example, only `body`.\n})\n\nconsole.log(JSON.stringify(response, null, 2))\n```\n\nThe `notion.request