Data requests

List all data requests of the individual

GET/v4/service/consent/organisation/data-status

Lists all the data requests of the individual in your organisation (delete, download and update), newest first, one page at a time. Use status to get only the open or only the closed requests.

isRequestsOngoing, isDataDeleteRequestOngoing and isDataDownloadRequestOngoing look only at the requests of this page: a request in state 1 or 2 of any type, of type 1 (delete), and of type 2 (download). To check one type over all requests, use its status route, for example Read the open data delete request of the individual. This route takes an API key or a token of the identity provider of the organisation, not an individual token or a token of the privacy dashboard login.

Language of the request sample

curl 'https://demo-api.igrant.io/v4/service/consent/organisation/data-status?status=open' \
  -H 'Authorization: ApiKey <your-api-key>'

{
  "dataRequests": [
    {
      "id": "6af2cdfc2d6fb7b6ac6efd17",
      "userId": "6af081b138e8f33dcf799628",
      "userName": "[email protected]",
      "organisationId": "6ae2bf741c3dadfeb27982ec",
      "type": 3,
      "typeStr": "Update Data",
      "state": 1,
      "requestedDate": "2026-11-10 07:55:40 +0000 UTC",
      "closedDate": "0001-01-01 00:00:00 +0000 UTC",
      "stateStr": "Request initiated",
      "comment": ""
    },
    {
      "id": "6af19d442d6fb7b6ac6efd11",
      "userId": "6af081b138e8f33dcf799628",
      "userName": "[email protected]",
      "organisationId": "6ae2bf741c3dadfeb27982ec",
      "type": 1,
      "typeStr": "Delete Data",
      "state": 2,
      "requestedDate": "2026-11-09 10:15:32 +0000 UTC",
      "closedDate": "0001-01-01 00:00:00 +0000 UTC",
      "stateStr": "Request acknowledged",
      "comment": "We are checking your request."
    },
    {
      "id": "6af187212d6fb7b6ac6efd0e",
      "userId": "6af081b138e8f33dcf799628",
      "userName": "[email protected]",
      "organisationId": "6ae2bf741c3dadfeb27982ec",
      "type": 2,
      "typeStr": "Download Data",
      "state": 7,
      "requestedDate": "2026-11-09 08:41:05 +0000 UTC",
      "closedDate": "2026-11-10 09:03:12.548 +0000 UTC",
      "stateStr": "Request processed with action",
      "comment": "We sent the export of your data to your e-mail address."
    }
  ],
  "isRequestsOngoing": true,
  "isDataDeleteRequestOngoing": true,
  "isDataDownloadRequestOngoing": false,
  "pagination": {
    "currentPage": 1,
    "totalItems": 3,
    "totalPages": 1,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": false
  }
}

Authorizations

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

Query parameters

offsetinteger
Number of records to skip for pagination. A negative or unreadable value falls back to 0.
At least 0.
Default:0
limitinteger
Maximum number of records to return per page.
Default:10
statusenum<string>
Filter by state. open: the requests in state 1 or 2. closed: the requests in state 6, 7 or 8. Leave it out (or send another value) to get all requests.
Available options:open,closed
Example:"open"

Headers

X-ConsentBB-IndividualIdstring
ID of the individual, or its externalId. Mandatory with an API key: without it the answer is 400 ("IndividualId is not present in request header"), and an unknown individual gets 400 too. With an individual token, leave it out: the server takes the individual from the token. Send it only on the routes that list it: with an API key that has resource scopes (for example consent-records:read), another route answers 400 to a request with this header.
Example:"6af081b138e8f33dcf799628"

Response

application/json

One page of data requests of the individual.

dataRequestsobject[] | null
The data requests of this page. null when offset is past the last data request.
isRequestsOngoingboolean
true when a request of this page is in state 1 or 2.
isDataDeleteRequestOngoingboolean
true when a delete request of this page is in state 1 or 2.
isDataDownloadRequestOngoingboolean
true when a download request of this page is in state 1 or 2.
paginationobject