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.

Query Params
integer
≥ 0
Defaults to 0

Page number (0-based).

integer
1 to 2000
Defaults to 1000

Number of records per page (1-2000).

boolean

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

Body Params
uuid

Filter Data Subject records by GUID

string

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

string

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

string

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

dataElements
array of objects

Filter Data Subject records by data elements with specific names and values

dataElements
string

Filter Data Subject records by preferred language code

boolean
Defaults to true

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

boolean
Defaults to false

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

boolean
Defaults to false

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

boolean
Defaults to false

When true, overrides the default sorting by last modified date

orgIds
array of uuids

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

orgIds
boolean

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*