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.

Recipes
🏫
Building your Own Preference Center UI
Open Recipe
Path Params
uuid
required

Preference Center UUID.

Query Params
string

Data Subject Identifier (prefer the header parameter).

Headers
string

Data Subject Identifier (prefer the header parameter).

Responses

Response body
object
string

The Data Subject identifier

DsDataElements
object

A list containing the Data Elements and their values for the specified Data Subject

Has additional fields
string

The Data Subject's preferred language code

Purposes
array of objects

A list of Purposes associated to the Data Subject

Purposes
object
CustomPreferences
array of objects

List of consented Custom Preferences associated to a Purpose

CustomPreferences
object
string

The description of the Custom Preference

string

Display Type of the Custom Preference Options

BUTTONS CHECKBOXES

uuid

Unique identifier of the Purpose and Custom Preference relation

Languages
array of objects

A list containing the Custom Preference's Languages

Languages
object
boolean

Whether this language is the default one for the Custom Preference

string

The description of the Custom Preference

string

The Custom Preference content language code

string

name for a Custom Preference

Options
array of objects

Options associated with a Custom Preference

Options
object
uuid

Unique Identifier identifying an Option

string

The Option label

string

The Custom Preference name

Options
array of objects

A list containing the Custom Preference's Options

Options
object
uuid

Unique Identifier identifying an Option

string

The Option label

boolean

Whether selection for this Custom Preference is required

string

Selection Type of the Custom Preference Options

SINGLE_CHOICE MULTI_CHOICE

string

Description of the Purpose

uuid

Unique Identifier of the Purpose

string

Name of the Purpose

string

Status of the Purpose

Topics
array of objects

List of consented Topics associated to a Purpose

Topics
object
uuid

The unique identifier of the Purpose and Topic relation

string

The Topic integration key (combination of Purpose and Topic names)

Languages
array of objects

Translations for a Topic

Languages
object
boolean

Whether this language is the default one for the Topic

string

The Topic content language code

string

The Topic name

string

The Topic name

string

Status for a Data Subject consent on a Purpose

int32

Status code for the Preference Center [200 (active), 400 (no transactions for this Data Subject)]

messages
array of strings
messages
boolean

Indicates whether a data subject has opted to unsubscribe from all Purposes within a Preference Center

401

Unauthorized

403

Forbidden

404

Not Found

Language
Credentials
OAuth2