Endpoints

The following sections document the actual endpoints that the HTTP API of Kadi4Mat provides, grouped by API version. The documentation of each endpoint includes required access token scopes, query parameters and/or request data as well as status codes specific to the endpoint. If not otherwise noted, the common request/response formats and status codes, as explained in the introduction section, apply for each of the documented endpoints.

It is also possible to retrieve a description of the endpoints following the OpenAPI specification using the endpoint https://<server_name>/openapi.json?v=<version> of a specific Kadi4Mat instance, where the <server_name> placeholder corresponds to the configured SERVER_NAME of Kadi4Mat, while the <version> placeholder corresponds to the desired API version. Note that this requires being logged in to the respective instance.

• v1 (stable)
  • Records
  • Collections
  • Templates
  • Users
  • Groups
  • Miscellaneous