WorkOS Node.js Library
See the API Reference for Node.js usage examples.
Install the package with:
yarn add @workos-inc/node
To use the library you must provide an API key, located in the WorkOS dashboard, as an environment variable
Or, you can set it on your own before your application starts:
import WorkOS from '@workos-inc/node'; const workos = new WorkOS('sk_1234');
For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.