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
properties=ignoreCountis not supported by this API. Count queries are never executed, so the API never returns the total number of elements.- The values passed in the
propertiesquery 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,ignoreTopics,ignoreCustomPreferences.- This API is not designed to be used in synchronous workflows. As an alternative, the Get Data Subject's Preferences API can be called.
- The
requestContinuationheader is required. Pagination using page number is not supported. The records returned for a request always depend on therequestContinuationvalue passed: specifynullfor the initial request and, for subsequent requests, pass therequestContinuationreturned in the response of the previous request. Whenlastistrue, there are no more pages to fetch, even though the last page still includes arequestContinuation. For more information, see Understanding & Implementing Pagination.- When specifying a data subject identifier, only the primary identifier is supported. Additional identifiers cannot be used for search or filtering.
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.
500Internal Server Error