--- updatedAt: 2026-05-27T12:49:39.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # 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. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Consent & Preferences - Universal Consent & Preference Management (OAS)", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "description": "The Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform." }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "Preference Centers", "description": "The Preference Centers APIs are used to manage data subjects' preferences in a preference center.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json" }, "x-displayName": "Preference Centers" } ], "paths": { "/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences": { "get": { "operationId": "getDataSubjectPurposesByIdentifierUsingGET_1", "summary": "Get Data Subject's Preferences in a Preference Center", "description": "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.", "tags": [ "Preference Centers" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json" }, "parameters": [ { "name": "prefcenterId", "in": "path", "description": "The unique identifier of a Preference Center.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "82bd54d4-433a-451e-8512-950da5f9c1c6" } }, { "name": "identifier", "in": "query", "description": "The data subject identifier associated with a data subject.", "required": false, "schema": { "type": "string", "example": "user@example.com" }, "deprecated": true }, { "name": "identifier", "in": "header", "description": "Data Subject Identifier (prefer the header parameter).", "required": false, "schema": { "type": "string", "example": "user@example.com" } } ], "responses": { "200": { "description": "OK - Successfully retrieved data subject's preferences.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPurposesByIdentifier" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "type": "string" } } } }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": [ "CONSENT", "CONSENT_READ" ] } ] } } }, "components": { "schemas": { "ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceLanguageDto": { "properties": { "Name": { "description": "name for a Custom Preference", "type": "string", "example": "Monthly" }, "Description": { "description": "The description of the Custom Preference", "type": "string", "example": "Options for different frequencies to receive emails" }, "Language": { "description": "The Custom Preference content language code", "type": "string", "example": "en-us" }, "Default": { "description": "The Option label", "type": "boolean", "example": true }, "Options": { "description": "Options associated with a Custom Preference", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceOptionDto" } } }, "required": [ "Description", "Name" ] }, "ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceOptionDto": { "properties": { "Id": { "description": "Unique Identifier identifying an Option", "type": "string", "format": "uuid", "example": "ca0fc41b-b28a-4335-804c-44d1f0f782ed" }, "Label": { "description": "The Option label", "type": "string", "example": "Weekly" }, "Order": { "description": "The order of the Option, Starts from 0", "type": "integer", "format": "int32", "example": 1 }, "IsDefault": { "description": "Whether the Option is default option or not", "type": "boolean", "example": true } } }, "ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeCustomPreferenceDto": { "properties": { "Id": { "description": "Unique identifier of the Purpose and Custom Preference relation", "type": "string", "format": "uuid", "example": "c4a57a38-3774-45ad-9fa4-dbc545542232" }, "Name": { "description": "The Custom Preference name", "type": "string", "example": "Email Frequency" }, "Description": { "description": "The description of the Custom Preference", "type": "string", "example": "Options for different frequencies to receive emails" }, "SelectionType": { "description": "Selection Type of the Custom Preference Options", "type": "string", "enum": [ "SINGLE_CHOICE", "MULTI_CHOICE" ] }, "DisplayAs": { "description": "Display Type of the Custom Preference Options", "type": "string", "enum": [ "BUTTONS", "CHECKBOXES" ] }, "Required": { "description": "Whether selection for this Custom Preference is required", "type": "boolean", "example": false }, "Options": { "description": "A list containing the Custom Preference's Options", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceOptionDto" } }, "Languages": { "description": "A list containing the Custom Preference's Languages", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCustomPreferenceLanguageDto" } } } }, "ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeTopicDto": { "properties": { "Id": { "description": "The unique identifier of the Purpose and Topic relation", "type": "string", "format": "uuid", "example": "497c4383-2c61-4906-aed0-660e3fd03ef0" }, "Name": { "description": "The Topic name", "type": "string", "example": "Car Marketing" }, "IntegrationKey": { "description": "The Topic integration key (combination of Purpose and Topic names)", "type": "string", "example": "Marketing-Communications_Car-Marketing" }, "Languages": { "description": "Translations for a Topic", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDto" } } } }, "ConsentPreferences-UniversalConsentPreferenceManag_TopicLanguageDto": { "properties": { "Name": { "description": "The Topic name", "type": "string", "example": "Car Marketing" }, "Language": { "description": "The Topic content language code", "type": "string", "example": "en-us" }, "Default": { "description": "Whether this language is the default one for the Topic", "type": "boolean", "example": true } } }, "ConsentPreferences-UniversalConsentPreferenceManag_PreferenceCenterPurposesByIdentifier": { "type": "object", "properties": { "DataSubjectId": { "description": "The Data Subject identifier", "type": "string", "example": "example@otprivacy.com" }, "Language": { "description": "The Data Subject's preferred language code", "type": "string", "example": "en-us" }, "Purposes": { "description": "A list of Purposes associated to the Data Subject", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PurposesByIdentifierDto" } }, "Status": { "description": "Status code for the Preference Center [200 (active), 400 (no transactions for this Data Subject)]", "type": "integer", "format": "int32", "example": 200 }, "DsDataElements": { "description": "A list containing the Data Elements and their values for the specified Data Subject", "type": "object", "example": [ { "First Name": "John", "Last Name": "Doe" } ], "additionalProperties": { "type": "object", "description": "A list containing the Data Elements and their values for the specified Data Subject", "example": [ { "First Name": "John", "Last Name": "Doe" } ] } }, "messages": { "type": "array", "items": { "type": "string" } }, "unsubscribeAll": { "description": "Indicates whether a data subject has opted to unsubscribe from all Purposes within a Preference Center ", "type": "boolean", "example": true } } }, "ConsentPreferences-UniversalConsentPreferenceManag_PurposesByIdentifierDto": { "properties": { "Id": { "description": "Unique Identifier of the Purpose", "type": "string", "format": "uuid", "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46" }, "Label": { "description": "Name of the Purpose", "type": "string", "example": "Marketing Communications" }, "Description": { "description": "Description of the Purpose", "type": "string", "example": "Collect customer emails for marketing purposes" }, "Status": { "description": "Status of the Purpose", "type": "string", "example": "ACTIVE" }, "TransactionStatus": { "description": "Status for a Data Subject consent on a Purpose", "type": "string", "example": "ACTIVE" }, "ExternalReference": { "type": "string" }, "Topics": { "description": "List of consented Topics associated to a Purpose", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeTopicDto" } }, "CustomPreferences": { "description": "List of consented Custom Preferences associated to a Purpose", "type": "array", "items": { "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PreferencePurposeCustomPreferenceDto" } } } } }, "securitySchemes": { "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "CONSENT": "Consent Scope gives the user access to read/write operations", "CONSENT_READ": "Consent Read Scope gives the user read-only access" } } } } } }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "x-onetrust": { "spec-label": "OpenAPI 3.1.0" } } ``` # Sibling pages * [Update Data Subject's Preferences in a Preference Center](https://developer.onetrust.com/onetrust/reference/updatepreferencesfordatasubjectapiusingput.md) * [Withdraw Data Subject's Consent for All Purposes in a Preference Center](https://developer.onetrust.com/onetrust/reference/withdrawpreferencesapiusingdelete.md) * [Get Preference Center Schema](https://developer.onetrust.com/onetrust/reference/getpreferencecenterbyidusingget.md)