---
title: "Get Preference Center Page Schema"
method: GET
path: "/api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema"
tags: ["Preference Centers V2"]
---

# Get Preference Center Page Schema

`GET /api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consentmanager/v2/preferencecenterpage/{preferencecenterpageid}/schema`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`, `CONSENT_READ`

Use this API to retrieve the schema for a specific page within a Multi Page Preference Center. The response will include the structure of the specified page within the Preference Center, including the sections, Purposes, and Data Elements.

## Path parameters

- `preferencecenterpageid` string, uuid, required

## Query parameters

- `state` 'PUBLISHED' | 'DRAFT'

## Response `200`

OK - Successfully retrieved preference center page schema.

- ConsentPreferencesUniversalConsentPreferenceManagPreferenceCenterPageDtoPagePublicAPI
  - `id` string, uuid: The unique identifier of the Preference Center Page
  - `order` integer: Order of Preference Center Page
  - `isHidden` boolean: Indicates if the Preference Center page header is hidden
  - `navigationEnabled` boolean: Indicates if the Preference Center page navigation is enabled
  - `displaySubscribeSettings` boolean: Indicates if Subscribe settings should be displayed on the page
  - `displayUnsubscribeAll` boolean: Indicates if the 'Unsubscribe All' option should be displayed on the page
  - `displaySubscribeAll` boolean: Indicates if the 'Subscribe All' option should be displayed on the page
  - `sections` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCenterSectionDtoPagePublicAPI[]: List of sections contained within this Preference Center page
    - `id` string, uuid: The unique identifier of the Preference Center Section
    - `identifierType` string: Type of identifier used for the section (e.g., Email, Phone, CustomID)
    - `isHeaderHidden` boolean: Indicates if the section header should be hidden
    - `order` integer: The display order of the section within the page
    - `purposes` ConsentPreferencesUniversalConsentPreferenceManagPCPurposeDtoPagePublicAPI[]: List of purposes associated with this section
      - `id` string, uuid: Unique identifier of the element
      - `order` integer: Display order of the element within the section
      - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: Available translations for the element's content
        - `name` string: Translated name of the item
        - `description` string: Translated description of the item
        - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
        - `content` string: Translated rich text content (may include HTML)
        - `language` string, required: Language code for this translation (ISO 639-1)
        - `isDefault` boolean: Indicates if this is the default translation
      - `label` string: Name of the purpose
      - `description` string: Detailed description of the purpose
      - `implicitConsentConfirmDesc` string: Description shown for the implicit consent confirmation checkbox
      - `version` integer: Version number of the purpose
      - `topics` ConsentPreferencesUniversalConsentPreferenceManagPCPurposeTopicDtoPagePublicAPI[]: List of topics associated with this purpose
        - `id` string, uuid: Unique identifier of the topic-purpose relationship
        - `name` string: Name of the topic
        - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: List of translations for the topic's name
          - `name` string: Translated name of the item
          - `description` string: Translated description of the item
          - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
          - `content` string: Translated rich text content (may include HTML)
          - `language` string, required: Language code for this translation (ISO 639-1)
          - `isDefault` boolean: Indicates if this is the default translation
      - `customPreferences` ConsentPreferencesUniversalConsentPreferenceManagPCCustomPreferenceDtoPagePublicAPI[]: List of custom preferences associated with this purpose
        - `id` string, uuid: Unique identifier of the custom preference
        - `name` string: Name of the custom preference
        - `description` string: Detailed description of the custom preference
        - `selectionType` 'SINGLE_CHOICE' | 'MULTI_CHOICE': Type of selection allowed for this preference
        - `displayAs` 'BUTTONS' | 'CHECKBOXES': How the preference options should be displayed
        - `required` boolean: Whether a selection is required for this preference
        - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: List of translations for the custom preference
          - `name` string: Translated name of the item
          - `description` string: Translated description of the item
          - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
          - `content` string: Translated rich text content (may include HTML)
          - `language` string, required: Language code for this translation (ISO 639-1)
          - `isDefault` boolean: Indicates if this is the default translation
        - `customPreferenceOptions` ConsentPreferencesUniversalConsentPreferenceManagPCCustomPreferenceOptionDtoPagePublicAPI[]: List of available options for this custom preference
          - `id` string, uuid: Unique identifier of the option
          - `label` string: Display label for the option
          - `order` integer: Display order of the option (0-based index)
          - `isDefault` boolean: Indicates if this option is selected by default
          - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: List of translations for the option label
            - `name` string: Translated name of the item
            - `description` string: Translated description of the item
            - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
            - `content` string: Translated rich text content (may include HTML)
            - `language` string, required: Language code for this translation (ISO 639-1)
            - `isDefault` boolean: Indicates if this is the default translation
      - `visibility` 'VISIBLE_TO_ALL' | 'VISIBLE_TO_CONSENTED' | 'VISIBLE_TO_PRIOR_CONSENTED': Visibility settings for the purpose in the preference center
    - `customDataElements` ConsentPreferencesUniversalConsentPreferenceManagPCCustomDataElementDtoPagePublicAPI[]: Custom data elements associated with this section
      - `id` string, uuid: Unique identifier of the element
      - `order` integer: Display order of the element within the section
      - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: Available translations for the element's content
        - `name` string: Translated name of the item
        - `description` string: Translated description of the item
        - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
        - `content` string: Translated rich text content (may include HTML)
        - `language` string, required: Language code for this translation (ISO 639-1)
        - `isDefault` boolean: Indicates if this is the default translation
      - `name` string: Name of the custom data element
      - `hidden` boolean: Whether the element is hidden from the UI
      - `readOnly` boolean: Whether the element is read-only
      - `required` boolean: Whether the element is required
    - `elements` ConsentPreferencesUniversalConsentPreferenceManagElementDtoPagePublicAPI[]: UI elements and components in this section
      - `id` string, uuid: Unique identifier of the element
      - `order` integer: Display order of the element within the section
      - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: Available translations for the element's content
        - `name` string: Translated name of the item
        - `description` string: Translated description of the item
        - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
        - `content` string: Translated rich text content (may include HTML)
        - `language` string, required: Language code for this translation (ISO 639-1)
        - `isDefault` boolean: Indicates if this is the default translation
    - `languages` ConsentPreferencesUniversalConsentPreferenceManagPCSectionTranslationDtoPagePublicAPI[]: Available language translations for this section
      - `name` string: Translated name of the item
      - `description` string: Translated description of the item
      - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
      - `content` string: Translated rich text content (may include HTML)
      - `language` string, required: Language code for this translation (ISO 639-1)
      - `isDefault` boolean: Indicates if this is the default translation
    - `isSubscriptionSettings` boolean: Indicates if this is the system-managed subscription settings section
  - `languages` ConsentPreferencesUniversalConsentPreferenceManagTranslationDtoPagePublicAPI[]: List of available language translations for this page
    - `name` string: Translated name of the item
    - `description` string: Translated description of the item
    - `implicitConsentConfirmDesc` string: Translated text for implicit consent confirmation
    - `content` string: Translated rich text content (may include HTML)
    - `language` string, required: Language code for this translation (ISO 639-1)
    - `isDefault` boolean: Indicates if this is the default translation

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `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)