Sign in

v1

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

Search Data Subjects

Use this API to search for data subjects based on various criteria. The response will include details for each matching data subject such as the associated data elements, data subject ID, and data subject identifier.

🗒 Things to Know

  • This API supports complex search criteria including filtering by data elements, purposes, and consent status.
  • For large result sets, use pagination to retrieve data in manageable chunks.
  • The response can be customized using the properties parameter to include or exclude certain data.

🚧

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.

post/api/consentmanager/v2/datasubjects/search

Query parameters

pageinteger

Page number (0-based).

sizeinteger
Example:1000

Number of records per page (1-2000).

isDNCIncludeboolean

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

Request body

idstring uuid

Filter Data Subject records by GUID

identifierstring

Filter Data Subject records by identifier (e.g., email, phone number)

updatedSincestring

Filter Data Subject records updated on or after this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)

updatedUntilstring

Filter Data Subject records updated on or before this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)

languagestring

Filter Data Subject records by preferred language code

includeCountsboolean

When false, the response will not include the total record count (improves performance for large result sets)

linkTokensboolean

When true, includes link tokens in the response for magic link functionality

linkedDSboolean

When true, includes additional linked Data Subject information in the response

ignoreDefaultSortboolean

When true, overrides the default sorting by last modified date

orgIdsstring[]

Filter Data Subject records by organization IDs (internal use only)

includeDataSubjectsWithOutPurposeTransactionsboolean

When true, includes Data Subjects that don't have any purpose transactions

Example request

{
  "id": "2a95b8c1-e54f-49f0-906a-2f5880450999",
  "identifier": "example@otprivacy.com",
  "updatedSince": "2023-01-01T00:00:00",
  "updatedUntil": "2023-12-31T23:59:59",
  "dataElements": [
    {
      "name": "Work Email",
      "value": "example@otprivacy.com"
    }
  ],
  "language": "en-us",
  "includeCounts": true
}

Response

OK - Search results returned 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
}