Preference Centers
Get Data Subject's Preferences in a Preference Center
Use this API to retrieve a data subject's preferences within a Preference Center. The response will include the list of Purposes that the data subject interacted with in the specified Preference Center along with their current status.
get/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences
Path parameters
prefcenterIdstring uuid required
Example:82bd54d4-433a-451e-8512-950da5f9c1c6
The unique identifier of a Preference Center.
Query parameters
identifierstring
Example:user@example.com
The data subject identifier associated with a data subject.
Headers
identifierstring
Example:user@example.com
Data Subject Identifier (prefer the header parameter).
Response
OK - Successfully retrieved data subject's preferences.
Example response
{
"DataSubjectId": "example@otprivacy.com",
"Language": "en-us",
"Purposes": [
{
"Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
"Label": "Marketing Communications",
"Description": "Collect customer emails for marketing purposes",
"Status": "ACTIVE",
"TransactionStatus": "ACTIVE",
"Topics": [
{
"Id": "497c4383-2c61-4906-aed0-660e3fd03ef0",
"Name": "Car Marketing",
"IntegrationKey": "Marketing-Communications_Car-Marketing",
"Languages": [
{
"Name": "Car Marketing",
"Language": "en-us",
"Default": true
}
]
}
],
"CustomPreferences": [
{
"Id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
"Name": "Email Frequency",
"Description": "Options for different frequencies to receive emails",
"Options": [
{
"Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
"Label": "Weekly",
"Order": 1,
"IsDefault": true
}
],
"Languages": [
{
"Name": "Monthly",
"Description": "Options for different frequencies to receive emails",
"Language": "en-us",
"Default": true,
"Options": [
{
"Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
"Label": "Weekly",
"Order": 1,
"IsDefault": true
}
]
}
]
}
]
}
],
"Status": 200,
"unsubscribeAll": true
}