v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Data Subjects V3

Get List of Data Subjects

❗️ Migration Recommendation

Please, do not adopt this API if you have not already done so. Continue to use the Get List of Data Subjects V1 API or request access to have Data Subjects V4 APIs enabled.

Use this API to retrieve a list of all data subjects. Depending on the query or header parameter values passed in the request, the response will return specific details about data subjects, including relevant information about the latest Collection Point update.

🗒 Things to Know

This API can also be used to retrieve the magic link token as linkToken in the response.

The identifier header parameter can be used to return information for a single data subject.

This API is designed to remain available during maintenance periods.

This API is not designed to be used in workflows.

get/rest/api/preferences/v3/datasubject-profiles

Query parameters

updatedSincestring date-time

The start of a date and time range used to filter data subject records/results that were last updated after the specified timestamp. The accepted format is yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

updatedUntilstring date-time

The end of a date and time range used to filter data subject records/results that were last updated before the specified timestamp. The accepted format is yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

collectionPointGuidstring uuid

UUID of the Collection Point.

purposeGuidstring uuid

UUID of the Purpose. purposeGuid can be obtained using the Get A Paged List Of Purposes endpoint.

pageinteger

Page number for pagination (zero-indexed).

sizeinteger

Number of records per page up to 2000 records per page. If a value above 2000 is used, only the first 2000 records will be returned.

sort'lastUpdatedDate,asc' | 'lastUpdatedDate,desc'

Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: lastUpdatedDate, createdDate.

Headers

identifierstring

Filter by data subject identifier.

dataElementNamestring

Name of the data element to filter by.

dataElementValuestring

Value of the data element to filter by.

requestContinuationstring

RequestContinuation token which should be used to navigate to the next page.

Response

List of data subjects retrieved successfully.

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

Example response

{
  "content": [
    {
      "id": "1b1f53d3-dc40-4288-abf1-74a4a4c33510",
      "language": "en-us",
      "identifier": "example@otprivacy.com",
      "lastUpdatedDate": "2020-01-12T16:11:25.479Z",
      "createdDate": "2020-01-12T16:11:25.479Z",
      "dataElements": [
        {
          "name": "Work Email",
          "doNotCall": true
        }
      ],
      "purposes": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "lastReceiptId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
          "name": "Marketing Communications",
          "version": 2,
          "status": "ACTIVE",
          "firstTransactionDate": "2020-01-05T11:34:30.974Z",
          "lastTransactionDate": "2020-01-12T16:11:25.479Z",
          "withdrawalDate": "2020-01-12T16:11:25.479Z",
          "consentDate": "2020-01-07T13:18:23.123Z",
          "expiryDate": "2020-01-07T13:18:23.123Z",
          "totalTransactionCount": 3,
          "topics": [
            {
              "id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
              "name": "Car Marketing"
            }
          ],
          "customPreferences": [
            {
              "id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
              "name": "Email Frequency",
              "options": [
                {
                  "Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
                  "name": "Weekly"
                }
              ]
            }
          ],
          "lastUpdatedDate": "2020-01-05T11:34:30.974Z",
          "lastInteractionDate": "2020-01-05T11:34:30.974Z"
        }
      ],
      "notices": [
        {
          "id": "05e30742-7e6c-4916-a5a1-7742a14ee984",
          "name": "Marketing Notice",
          "url": "www.onetrust.com",
          "privacyNoticeGuid": "1439b150-ef4c-444c-a20e-44622c8ccaf3",
          "type": "EMBEDDED",
          "purposes": [
            {
              "guid": "cbac5669-1445-4520-ba15-b1993902b295",
              "name": "Entity Name"
            }
          ],
          "privacyNoticeVersion": {
            "guid": "fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279",
            "name": "Entity Name",
            "version": 1
          },
          "collectionPoint": {
            "guid": "fcfe3c5e-6b1d-4eac-a5a4-aa7c8719b279",
            "name": "Entity Name",
            "version": 1
          }
        }
      ],
      "testDataSubject": true,
      "LinkToken": "jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ="
    }
  ],
  "number": 1,
  "size": 20
}