ONonetrust
Purpose Preferences

Get List of Purpose Preferences

Use this API to retrieve a list of all Purpose Preferences. The response will include basic details such as the Purpose Preference name, languages, number of options, created date, and updated date.

get/api/consentmanager/v1/custompreferences

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/consentmanager/v1/custompreferences
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: CONSENT, CONSENT_READ

Query parameters

pageinteger

The page number of the results (0-based).

sizeinteger
Example:20

The number of results per page.

sort'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'selectionType,asc' | 'selectionType,desc'
Example:createdDate,desc

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

Response

OK - List of Custom Preferences retrieved successfully.

string required

Changes

No recorded changes to this operation across all 1 revision of this API.