Privacy Dashboard

Read privacy dashboard

GET/v4/config/platform/privacy-dashboard

Reads the privacy dashboard deployment of the organisation as the service records it: the host name, the release, the status and the button labels. To compare the record with the deployment in the cluster, use Read privacy dashboard deployment status.

Language of the request sample

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

{
  "hostname": "acme-privacy.igrant.io",
  "version": "v2026.10.1",
  "status": 2,
  "statusStr": "Deployed",
  "buttonLabels": {
    "dataUsingServicesButtonLabel": ""
  }
}

Authorizations

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

Response

application/json

The privacy dashboard record.

hostnamestring
Host name of the privacy dashboard, for example acme-privacy.igrant.io. Empty when not deployed.
Example:"acme-privacy.igrant.io"
versionstring
Release of the privacy dashboard (a version of List privacy dashboard releases). Empty when not deployed.
Example:"v2026.10.1"
statusenum<integer>
Status of the deployment: 0 not configured, 1 requested (a deployment started and did not complete), 2 deployed.
Available options:0,1,2
Example:2
statusStrenum<string>
Label of status.
Available options:Not Configured,Requested,Deployed
Example:"Deployed"
buttonLabelsobject
The labels of the buttons of the privacy dashboard.