REST API Documentation

A master list of REST API endpoints, their purpose, parameters and return types - together with cross-references to UI functions and sample API calls.

List of Request Headers

Request header Description

Required, except for POST user/login API
The access token, which should be requested firstly using POST user/login API

Required if logged in user is a tenant user
The id of the tenant of the logged in user
The id of the selected tenant. This is used in case the logged in user is a system user, and selects setting level as a specific tenant.

For an example on adding request headers, please see Code sample for calling REST API.

List of APIs