Get List of Data Subjects with Consented Purposes

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=ignoreCount is 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 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, 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 requestContinuation header is required. Pagination using page number is not supported. The records returned for a request always depend on the requestContinuation value passed: specify null for the initial request and, for subsequent requests, pass the requestContinuation returned in the response of the previous request. When last is true, there are no more pages to fetch, even though the last page still includes a requestContinuation. 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.

Query Params
date-time

Restrict information to changes in consent information since a given date: formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss. Note that the since and updatedSince parameters cannot be used in conjunction.

date-time

Filter Data Subjects records that were last updated before the specified date: formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

date-time

Filter Data Subject records that were last updated after the specified date: formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss. Note that the since and updatedSince parameters cannot be used in conjunction.

string
deprecated

Data subject identifier to filter results. Prefer using the identifier header parameter.

uuid

Restrict information to only DataSubjects related to a purpose.

uuid

Restrict information to only DataSubjects related to a collection point id.

string

Restrict information to only DataSubjects related to a collection point name.

string

Specify optional properties, any of: [linkTokens] return linkTokens, [ignoreTopics] will exclude Topics from Purposes, [ignoreCustomPreferences] will exclude Custom Preferences from Purposes. This is the preferred option for a fast response on large datasets, [includeAllPreferences] will include for all Topics and CustomPreferenceOptions attached to Purposes a boolean value specifying whether the Topic/CustomPreferenceOption has been consented to or not, [includeNotices] will include the privacy notices the data subject has consented to in each profile, eg: properties=linkTokens,ignoreCustomPreferences,includeAllPreferences

boolean

Include effective status of Data Subject Profiles (true/false).

uuid

Unique identifier identifying a Linked Identity Group.

boolean

Include consent attachments of DataSubject (true/false).

boolean

Include DNC records (true/false).

boolean
Defaults to true

Include data subjects with no organization (true/false).

boolean

Include Geolocation parameters of the DataSubject (true/false).

integer
1 to 50
Defaults to 20

Number of records per page.

string
enum
Defaults to id,desc

Sorting criterion in the format property,direction, where direction is asc or desc (asc when omitted). Only one criterion is supported. Default is id,desc.

Headers
string

Restrict information to one DataSubject.

string

Filter Data Subject records with Data Element name. Note that it must be used in conjunction with dataElementValue.

string

Filter Data Subject records with Data Element value. Note that it must be used in conjunction with dataElementName.

string
required

Continuation token used to retrieve the next page of results. Specify null for the initial request. For subsequent requests, provide the continuation token returned in the previous response.

Responses

500

Internal Server Error

Language
Credentials
OAuth2
Missing 2 required scopes
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*