Skip to content


In this documentation, API calls are hierarchically organized by pertinency.
Each API call is identified by his endpoint and all possible combinations of recurring patterns are anyhow made explicit in different API calls.
Any API call is described in the most possible exhaustive way in order to comprehend any necessary element, without having to navigate through other pages in order to build the desired call.


API calls HTTP methods will be marked with the following colors in order to be recognizable at glance:

▪ GET              ▪ POST              ▪ PUT              ▪ DELETE


Deprecated API calls will be strikethrough and marked with :fontawesome-solid-exclamation-circle:, which means that is highly recommended not to use that API call as it will be removed soon.
Corresponding replacing API calls will be marked with :fontawesome-solid-sync-alt:.