Organisation

Read API status

GET/v4/onboard/platform/status

Returns the tenant mode and the version of the API. Use it to check that your API key works and which release of the API answers.

Read API status

Language of the request sample

curl 'https://demo-api.igrant.io/v4/onboard/platform/status' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "applicationMode": "multi-tenant",
  "version": "v2026.10.10",
  "candidate": "release",
  "revision": "b0de5352"
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:organisation:read

application/json

The tenant mode and the version of the API.

applicationModeenum<string>
The tenant mode of the installation: multi-tenant for an installation with many organisations, single-tenant for an installation with one organisation.
Available options:multi-tenant,single-tenant
Example:"multi-tenant"
versionstring
The release of the API (the Git tag of the build).
Example:"v2026.10.10"
candidatestring
The kind of build, release for a release build, else dev.
Example:"release"
revisionstring
The short Git commit of the build. Can be empty.
Example:"b0de5352"