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 data elements, purposes, associated topics, and purpose preferences. The response will also include relevant information about the latest Collection Point interactions and receipt IDs, along with the current status of consent for the purposes and preferences they have interacted with.

🗒

Things to Know

  • It is critical that all queries include properties=ignoreCount. Not including ignoreCount will significantly decrease performance. If you need the count, we advise to only include it in the initial query, and not for subsequent page calls.
  • The values passed in the properties query parameter can change the response of this API. A fast response on large data sets can be obtained passing any of the following values: linkTokens, ignoreCount, ignoreTopics, ignoreCustomPreferences.
  • This API is not designed to be used in synchronous workflows. As an alternative, the Gets preferences for a Data Subject API can be called.
  • It is strongly recommended to pass the requestContinuation parameter returned in the response of this API in the next API request to paginate. Including it is crucial for better performance when dealing with multiple pages of data subject records. For more information, see Understanding & Implementing Pagination.

🚧

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.

Recipes
⛓️
Retrieve Data Subject Consent for all Members of the Data Subject Group
Open Recipe
🖨️
Copy Existing Data Subject Profile to New Data Subject Profile
Open Recipe
Language
Credentials
OAuth2