Introduction to the API

Welcome to the Umetrics® Studio REST API Reference.

The API is organized around the REST architectural style. It has predictable, resource-oriented URLs, accepts and returns JSON-encoded bodies, and uses standard HTTP response codes, authentication, and versioning.



The API uses access token with appropriate scopes and permissions to authenticate requests. All requests must be made over HTTPS. Calls made over plain HTTP or without authentication will fail.

Check Authentication section for more details.


API uses conventional HTTP response codes to indicate the success or failure of an API request. A list of potential error codes with detailed explanation is available in the Error codes section.

Check Error codes section for more details.


An API version is identified by the date of its publication in an HTTP header, e.g. Sartorius-Studio-Api-Version: 2024-03-21. When introducing changes to the API that are not backward-compatible, a new version of the API will be published, identified by a new date. To explore detailed information on all updates to the API, please refer to the API changelog.

Check Versioning section for more details.


All notable changes to API will be documented in this section. It includes information on new features, enhancements, bug fixes, and deprecated functionalities.

Check Changelog section for more details.

REST API Reference

To discover the available endpoints, refer to the interactive documentation for each version accessible via the left panel, under the REST API REFERENCE section.