Sign in

v1

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

Get List of Data Subjects

Use this API to retrieve a list of all data subjects. The response will include details for each data subject such as the associated data elements, data subject ID, and data subject identifier. By default, the response will return data subject details sorted in descending order of last modified date.

🗒 Things to Know

🚧

Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.

get/api/consentmanager/v2/datasubjects

Query parameters

pageinteger

Page number (0-based).

sizeinteger
Example:20

Number of records per page (1-50).

updatedSincestring date-time
Example:2023-01-01T00:00:00

Filter Data Subject records that were last updated on or after the specified date. Formats accepted: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

updatedUntilstring date-time
Example:2023-12-31T23:59:59

Filter Data Subject records that were last updated on or before the specified date. Must be used with updatedSince. Formats accepted: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

idstring uuid
Example:a9adf402-adcd-45be-b981-a56a5c0739ec

Filter by data subject ID (UUID).

languagestring
Example:en

Filter by language code (e.g., 'en', 'fr').

propertiesstring
Example:ignoreCount,linkTokens

Specify optional properties to control the response. Multiple values can be comma-separated.

  • ignoreCount: Skip the total record count calculation (improves performance)
  • linkTokens: Include link tokens in the response
  • ignoreDefaultSort: Disable default sorting by last modified date
includeDataSubjectsWithOutPurposeTransactionsboolean

Include data subjects without purpose transactions (true/false).

isDNCIncludeboolean

Include Do Not Call list information (true/false).

Headers

identifierstring
Example:user@example.com

Filter by data subject identifier (prefer using the header parameter).

dataElementNamestring
Example:Email

Filter by data element name (must be used with dataElementValue).

dataElementValuestring
Example:user@example.com

Filter by data element value (must be used with dataElementName).

Response

OK - 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": "633ba071-61b0-485f-81a0-a2245777b432",
      "identifier": "example@otprivacy.com",
      "language": "en-us",
      "lastUpdatedDate": "2020-01-12T16:11:25.479Z",
      "dataElements": {
        "Title": "Mr",
        "FirstName": "Example"
      },
      "dataElementsMetaData": [
        {
          "name": "Work Email",
          "linked": true,
          "doNotCall": true
        }
      ],
      "linkToken": "jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ=",
      "createdDate": "2020-01-12T16:11:25.479Z",
      "identifierType": "Email"
    }
  ],
  "number": 1,
  "size": 20
}