List data subject requests.

GET https://api.consentgrid.io/v1/dsr/requests?query
Authorization: Bearer apiKey
GET https://api.consentgrid.io/v1/dsr/my/{acct}/requests?query
cookie cgs_{accountURL}: session

This call accepts the following query parameters

types
Comma separated request type ids to list. If ommitted, all types are included.
labels
Comma separated labels to select requests.
status
Comma separated statuses to list.
owner.type
User type of the DSR owner
owner.id
User id of the DSR owner
from
Starting offset in the result set. Result set is ordered by date.
n
Maximum results to return. If omitted, result set is capped at 100.

If the API is called using a session cookie or token, only the requests of the session user are returned.

Response

200 Ok

The response is a list of DSR request objects.

{
  "total":2,
  "requests": [ {
    "id": "item id",
    "version": 2,
    "typeId": "deletion",
    "typeName": "Data deletion request",
    "labels": [ "label1", "label2", ...],
    "enteredBy": { "type": "user", "id": "..."},
    "enteredOn": "20200203T00:00:00Z",
    "modifiedBy": { "type": "user", "id": "..." },
    "modifiedOn": "20020303T00:00:00Z",
    "status": "submitted",
    "owner": {
      "type": "user",
      "id": "...",
      "uri": "https://api.consentgrid.io..."
    },
    "data": {
    Fields defined for request type
    },
    "metadata": {
      "key": "value",
      ...
    },
    "attachments": {
      "attachmentField": [
        {
           "fileName": "file.png",
           "contentType": "image/png",
           "uri": "https://api.consentgrid.io..."
        },
        ...
      ],
      ...
    }
  },
  ...
  ]
}
400 Bad Request

Malformed request, invalid value, etc. The return value is a JSON error object containing diagnostic information.

403 Forbidden

The authenticated key does not have the privileges for this operation. The return value is a JSON error object containing diagnostic information.