Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subjects V4

Get List of Data Subjects

Use this API to retrieve a list of data subjects that were last updated between the specified date range. The response will include basic details, such as each data subject’s identifier, created date, data elements, and last updated date.

🗒 Things to Know

  • The maximum date range that can be returned is 7 days.
get/rest/api/consent/v4/datasubjects

Query parameters

fromDatestring date-time required

The start of a date and time range used to filter results.

toDatestring date-time required

The end of a date and time range used to filter results.

isDNCIncludeboolean

Indicates whether to include data subject in the response if the data subject is in the DNC list.

pageinteger

The page number of the results.

sizeinteger

The number of results per page.

sort'lastModifiedDate,asc' | 'lastModifiedDate,desc'

The sort criteria that dictates the order of the results.

Headers

requestContinuationstring

The token used to paginate a response if the number of records is more than a page.

Response

OK

numberinteger

The page number of the results.

sizeinteger

The number of results per page.

lastboolean

Flag indicating whether this is the last page or not.

firstboolean
numberOfElementsinteger
emptyboolean
requestContinuationstring

The token used to paginate a response if the number of records is more than a page.

Example response

{
  "content": [
    {
      "identifier": "example@otprivacy.com",
      "identifierType": "Email",
      "language": "en-us",
      "createdDate": "2020-01-12T16:11:25.479Z",
      "lastTransactionDate": "2020-01-12T16:11:25.479Z",
      "lastReceiptGuid": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "testDataSubject": true,
      "dataElements": [
        {
          "name": "Work Email",
          "doNotCall": true
        }
      ],
      "latestGeoLocation": {
        "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
        "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
        "country": "US",
        "state": "GA",
        "stateName": "Georgia"
      },
      "latestSource": {
        "dataSubjectId": "633ba071-61b0-485f-81a0-a2245777b432",
        "receiptGuid": "633ba071-61b0-485f-81a0-a2245777b432",
        "sourceType": "WEB",
        "sourceContent": "https://example.com/consent"
      },
      "id": "633ba071-61b0-485f-81a0-a2245777b432",
      "lastUpdatedDate": "2020-01-12T16:11:25.479Z",
      "doNotCall": true,
      "notices": [
        {
          "id": "05e30742-7e6c-4916-a5a1-7742a14ee984",
          "name": "Marketing Notice",
          "url": "www.onetrust.com",
          "guid": "1439b150-ef4c-444c-a20e-44622c8ccaf3",
          "type": "EMBEDDED",
          "purposes": [
            {
              "guid": "15e30742-7e6c-4916-a5a1-7742a14ee284",
              "name": "Marketing"
            }
          ],
          "privacyNoticeVersion": {
            "guid": "15e30742-7e6c-4916-a5a1-7742a14ee284",
            "name": "Marketing",
            "version": 1,
            "minorVersion": 2
          },
          "collectionPoint": {
            "guid": "15e30742-7e6c-4916-a5a1-7742a14ee284",
            "name": "Marketing",
            "version": 1,
            "minorVersion": 2
          }
        }
      ],
      "attachments": [
        {
          "attachmentId": "25d9ccac-db88-4d34-849c-3d602a629961",
          "fileName": "policy.pdf",
          "uploadedBy": "John Doe",
          "uploadDate": "2024-01-01T00:00:00"
        }
      ]
    }
  ],
  "number": 1,
  "size": 20,
  "requestContinuation": "{\\\"compositeToken\\\": \\\"jmxpAKZxe9nZkAoAAAAAAA==\\\"}"
}