Get Data Subject's Preferences
❗️ End of Support Notification
As of November 23, 2025, this API is now deprecated. Any customers leveraging this API are encouraged to use the Get Data Subject’s Preferences V2 API. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.
Use this API to retrieve a list of all consent preferences for a data subject identifier. The response will include details such as consent date, Purpose Preferences, and data subject's geolocation. The response will also include relevant information about data elements and last interaction date, along with the current status of consent for the purposes that the data subject has interacted with.
🗒 Things to Know
- This API uses an authorization token with public key model that reduces query response time and bypasses rate limits that are in place with the main APIs that rely on querying the main OneTrust database.
- This API does not require an intermediary server-server API call. It is optimized for client-side applications, maintaining security to make quick decisions based on data subject consent.
- The response of this API will not return updates made via the Update Data Subject's Preferences in a Preference Center API.
Query parameters
UUID of the sync group.
Headers
ID of a data subject.
UUID of the tenant. The value can be retrieved in the OneTrust application using Get Help > Contact Us > Account ID.
Authorization token for the data subject. Refer Using an authorization token with public key model for more details.
Response
Response body contains a list of preferences with the current consent status for a data subject.
Example response
{
"preferences": [
{
"geolocation": {
"receiptGuid": "788ba071-61b0-485f-81a0-a2245777b432",
"country": "US",
"state": "GA",
"stateName": "Georgia"
},
"latestGeolocation": {
"receiptGuid": "788ba071-61b0-485f-81a0-a2245777b432",
"country": "US",
"state": "GA",
"stateName": "Georgia"
}
}
]
}