---
title: "Get Data Subject's Preferences in a Preference Center"
method: GET
path: "/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences"
tags: ["Preference Centers"]
---

# Get Data Subject's Preferences in a Preference Center

`GET /api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`, `CONSENT_READ`

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.

## Path parameters

- `prefcenterId` string, uuid, required

## Query parameters

- `identifier` string

## Headers

- `identifier` string

## Response `200`

OK - Successfully retrieved data subject's preferences.

- ConsentPreferencesUniversalConsentPreferenceManagPreferenceCenterPurposesByIdentifier
  - `DataSubjectId` string: The Data Subject identifier
  - `Language` string: The Data Subject's preferred language code
  - `Purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposesByIdentifierDto[]: A list of Purposes associated to the Data Subject
    - `Id` string, uuid: Unique Identifier of the Purpose
    - `Label` string: Name of the Purpose
    - `Description` string: Description of the Purpose
    - `Status` string: Status of the Purpose
    - `TransactionStatus` string: Status for a Data Subject consent on a Purpose
    - `ExternalReference` string
    - `Topics` ConsentPreferencesUniversalConsentPreferenceManagPreferencePurposeTopicDto[]: List of consented Topics associated to a Purpose
      - `Id` string, uuid: The unique identifier of the Purpose and Topic relation
      - `Name` string: The Topic name
      - `IntegrationKey` string: The Topic integration key (combination of Purpose and Topic names)
      - `Languages` ConsentPreferencesUniversalConsentPreferenceManagTopicLanguageDto[]: Translations for a Topic
        - `Name` string: The Topic name
        - `Language` string: The Topic content language code
        - `Default` boolean: Whether this language is the default one for the Topic
    - `CustomPreferences` ConsentPreferencesUniversalConsentPreferenceManagPreferencePurposeCustomPreferenceDto[]: List of consented Custom Preferences associated to a Purpose
      - `Id` string, uuid: Unique identifier of the Purpose and Custom Preference relation
      - `Name` string: The Custom Preference name
      - `Description` string: The description of the Custom Preference
      - `SelectionType` 'SINGLE_CHOICE' | 'MULTI_CHOICE': Selection Type of the Custom Preference Options
      - `DisplayAs` 'BUTTONS' | 'CHECKBOXES': Display Type of the Custom Preference Options
      - `Required` boolean: Whether selection for this Custom Preference is required
      - `Options` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCustomPreferenceOptionDto[]: A list containing the Custom Preference's Options
        - `Id` string, uuid: Unique Identifier identifying an Option
        - `Label` string: The Option label
        - `Order` integer: The order of the Option, Starts from 0
        - `IsDefault` boolean: Whether the Option is default option or not
      - `Languages` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCustomPreferenceLanguageDto[]: A list containing the Custom Preference's Languages
        - `Name` string, required: name for a Custom Preference
        - `Description` string, required: The description of the Custom Preference
        - `Language` string: The Custom Preference content language code
        - `Default` boolean: The Option label
        - `Options` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCustomPreferenceOptionDto[]: Options associated with a Custom Preference
          - `Id` string, uuid: Unique Identifier identifying an Option
          - `Label` string: The Option label
          - `Order` integer: The order of the Option, Starts from 0
          - `IsDefault` boolean: Whether the Option is default option or not
  - `Status` integer: Status code for the Preference Center [200 (active), 400 (no transactions for this Data Subject)]
  - `DsDataElements` object: A list containing the Data Elements and their values for the specified Data Subject
  - `messages` string[]
  - `unsubscribeAll` boolean: Indicates whether a data subject has opted to unsubscribe from all Purposes within a Preference Center

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)