You are reading the documentation for an outdated Corteza release. 2023.9 is the latest stable Corteza release.

API clients

Corteza defines a series of JavaScript API clients (SDK’s) to work with our API.

When writing automation scripts, they are provided in the execution context.

You can find the source code on GitHub/cortezaproject/corteza-js. NPM packages can be found on NPM/@cortezaproject/corteza-js.

Make sure to use the same @cortezaproject/corteza-js package version as your Corteza instance.

When using our corteza-js package, the API clients can be imported using import { apiClients } from '@cortezaproject/corteza-js'.

Please refer to the source code for a complete reference.