Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Preference Centers V2

Get List of Preference Centers

Use this API to retrieve a list of all Preference Centers. The response will include details for each Preference Center along with the corresponding Preference Center ID, created date, and published date.

get/api/consentmanager/v2/preferencecenters

Query parameters

pageinteger

Results page you want to retrieve (0-based).

sizeinteger
Example:20

Number of records per page.

sort'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'status,asc' | 'status,desc' | 'version,asc' | 'version,desc'
Example:createdDate,desc

Sorting criteria in the format: property,(asc|desc). Default sort order is descending by ID. Multiple sort criteria are supported.

dataElementGuidstring uuid
Example:133323f3-cf99-4b9d-a103-040bd6643d3f

Filter preference centers by data element GUID.

Response

OK - Successfully retrieved list of preference centers.

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.

Example response

{
  "content": [
    {
      "id": "09ccd1b9-84a0-4bcb-a167-f761391ebffa",
      "name": "Email Communication Preferences",
      "organizationName": "OneTrust"
    }
  ],
  "first": true,
  "numberOfElements": 20,
  "totalPages": 5,
  "totalElements": 50,
  "size": 20
}