Skip to main content

API Versioning

The Kojo API uses semantic versioning. Each version will be in the format MAJOR.MINOR.PATCH. Each portion of the version number is updated in the following situation:

  • MAJOR for backwards-incompatible API changes,
  • MINOR for backwards-compatible API changes, and
  • PATCH for backwards-compatible bug fixes.

You must explicitly specify the MAJOR version of the Kojo API in the request header X-Api-Version. For example, the MAJOR version 1 would be accessed using the header:

X-Api-Version: 1

Or, with curl:

$ curl -X POST -H "X-Api-Version: 1" ... https://api.kojo.tech/graphql ...

All responses from the API will include a similar header that includes the full semantic version. For example: X-Api-Version: 1.2.3.

Version Support​

MAJOR versions will be deprecated over time. Kojo will support deprecated major versions for 6 months to allow you time to migrate to a new MAJOR version. You will be notified via email when a version is deprecated.

Please contact us if you cannot migrate to a newer MAJOR version within 6 months.