Notion-Version header. Setting this header is required.
text when creating or updating a page. Once you upgrade to the new version, you will need to use rich_text to set that same text property.
Similarly, the page response will be returned with the property type text on the old version, while on the new version, the response will say rich_text.
Versioning is only for backwards incompatible changesFor new features and additions to the API, such as adding a new API endpoint, or including a new object in an existing API endpoint’s response, there won’t be a new version. You’ll be able to take advantage of any new functionality on the version of the API you’re currently using.
v1. This is not related to the versioning described above. We don’t intend to change these URLs.
Frequently asked questions
How do releases of the JavaScript SDK work?
How do releases of the JavaScript SDK work?
Releases of the Notion SDK for JavaScript are published to NPM as
@notionhq/client
and use a separate semantic versioning scheme.
View the GitHub release notes for the latest version and changes over time. Some SDK changes are also
featured in the API changelog.When upgrading to a new “minor” or “patch” version of the SDK, you generally won’t need to make any code changes to your integration. These updates contain backwards-compatible
improvements and fixes.However, new “major” versions of the SDK are not backwards-compatible, and you may need to make updates to your integration.Some major releases drop support for older Notion API versions and update the default version used to make requests when no
For example,
To manage this upgrade, refer to the upgrade guide. See the compatibility table in the README to see which versions of the SDK are compatible with which versions of the API.
notionVersion is provided to
the SDK Client constructor.For example,
v5.0.0 and above dropped support for 2022-06-28 and earlier, and only works well with 2025-09-03 and above.
To manage this upgrade, refer to the upgrade guide. See the compatibility table in the README to see which versions of the SDK are compatible with which versions of the API.
Will staying on an older API version work indefinitely?
Will staying on an older API version work indefinitely?
We don’t currently have any plans to stop supporting older API versions. If this changes in the future, we’ll communicate this with all affected
users and provide a time window and migration guidance. However, we recommend upgrading to the latest version
to take advantage of the latest features and improvements.