Version 2 of our public API has been in widespread use for quite some time and has effectively served as the standard for most integrations. Until now, however, version 1 remained the default reference in our Developer Hub documentation (just visually, however).

To better reflect the reality of current usage and reduce confusion for new integrators, we’ve updated the Developer Hub to make version 2 the default across all interactive documentation, code examples, and references.

Version 1 remains available for compatibility purposes, but we recommend using version 2 for all new projects and ongoing development.

This change does not affect any functional aspects of the API — it simply aligns our documentation with the version that developers are already actively working with.

Various internal components have been refactored regarding access. Therefore, the interface of some relational entities has changed. In addition, the validators are more strict now and check for proper access on every entity. Some entities have been disabled as they are not fully supported, yet.

Content-Range Response Header on Paginated List Endpoints

Paginated list endpoints will return the Content-Range is a response header besides the values of pageNumber, totalCount and totalPages in the response body. Having that, it's possible to fetch counts by issuing HEAD requests and evaluating the Content-Range header.

Response of Delete Requests

Delete requests of all entities return 204 OK instead of 200 OK with an empty object.

Response of Create Requests on Sub-Entities

When creating a sub entity such as an Attribute Group on a Unit, instead of returning the created attribute group, you'll receive a paginated response of the collection where you've added the entry to (e.g. units/{id}/attribute-groups.

This is our first release making various endpoints available. Feel free to check out the API Reference.