---
title: "Get Data Subject's Preferences"
method: GET
path: "/v2/preferences"
tags: ["Preferences V2"]
---

# Get Data Subject's Preferences

`GET /v2/preferences`

Use this API to retrieve a list of all consent preferences for a data subject identifier. The response will include details such as the 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 a JSON Web Token (JWT) authorization token that will be passed to OneTrust servers to ensure authenticated access to a user's consent profile. This is not the OAuth 2.0 client credential or API key. This JWT authorization token is generated using the cross-device consent process. For more information, see [Cross-Domain and Cross-Device Consent](https://my.onetrust.com/s/article/UUID-750c79df-692c-7418-a395-af2acaa45601).
> - 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](https://developer.onetrust.com/onetrust/reference/updatepreferencesfordatasubjectapiusingput).

## Headers

- `identifier` string, required
- `tenantId` string, uuid, required
- `Authorization` string, required

## Response `200`

OK

- PreferencesDto
  - `consentDate` string, date-time — The date and time at which the Data Subject gave their consent based on the interaction date for a Confirmed Transaction.
  - `customPreferences` object — The list of Custom Preferences associated with the Purpose.
  - `geolocation` DataSubjectGeolocationDto — Provides geolocation information for a data subject if they have given consent to a purpose with geolocation tracking enabled.
    - `receiptGuid` string, uuid — Unique Identifier of the Receipt for which geolocation parameters were sent.
    - `country` string — Country of the DataSubject.
    - `state` string — State Code of the DataSubject.
    - `stateName` string — State Name of the DataSubject.
  - `dataElements` object — The names and values of Data Elements added via a consent receipt.
  - `expiryDate` string, date-time — The date and time at which the Data Subject's consent expires. The expiryDate will only be included in the response if the expiration date is explicitly set using the Consent Receipt API.
  - `id` string, uuid — The preferences id is the Purpose GUID that the consent status relates to.
  - `lastInteractionDate` string, date-time — The most recent date and time at which the Data Subject last made a choice for a particular Purpose.
  - `purposeLastUpdatedDate` string, date-time — The most recent date and time when the Purpose status was changed, the Purpose version was updated, or any changes were made to Topic or Custom Preference option selections.
  - `purposeVersion` integer — The version of the purpose that the Data Subject consented to.
  - `status` 'EXPIRED' | 'WITHDRAWN' | 'NO_CONSENT' | 'PENDING' | 'ACTIVE' | 'OPT_OUT' | 'ALWAYS_ACTIVE' | 'HARD_OPT_OUT' | 'EXTEND' | 'NOT_OPT_OUT' — The Data Subject's consent status for the Purpose.
  - `syncGroups` string, uuid — The GUID of the sync group for which preferences are returned. This is an optional parameter that allows you to retrieve only the Purposes for a specified Sync Group.
  - `topics` string[] — The list of topics associated with the Purpose.
  - `latestGeolocation` DataSubjectGeolocationDto — Provides geolocation information for a data subject if they have given consent to a purpose with geolocation tracking enabled.
    - `receiptGuid` string, uuid — Unique Identifier of the Receipt for which geolocation parameters were sent.
    - `country` string — Country of the DataSubject.
    - `state` string — State Code of the DataSubject.
    - `stateName` string — State Name of the DataSubject.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)