Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Purposes V2

Get List of Purpose Versions

Use this API to retrieve a list of Purpose versions. The response will include details for each Purpose version along with the corresponding Purpose ID, created date, and published date.

🗒 Things to Know

  • This API returns Purpose descriptions inside <p> and </p> HTML tags. These can be sanitized depending on your formatting needs.
get/api/consentmanager/v2/purposes

Query parameters

latestVersionboolean

In order to retrieve only the latest version of each Purpose this property should be set to true.

includeRetiredboolean

In order to include retired versions for each Purpose this property should be set to true.

organizationstring uuid

Organization ID to filter purposes by.

includeCustomPreferencesboolean

In order to retrieve custom preferences for each version of Purposes this property should be set to true.

includeTopicsboolean

In order to retrieve topics for each version of Purposes this property should be set to true.

fromLastModifiedDatestring date-time
Example:2023-01-01T00:00:00

Filter purposes modified after this date (format: yyyy-MM-dd'T'HH:mm:ss).

toLastModifiedDatestring date-time
Example:2023-12-31T23:59:59

Filter purposes modified before this date (format: yyyy-MM-dd'T'HH:mm:ss).

pageinteger

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

sizeinteger
Example:20

Number of records per page.

sort'guid,asc' | 'guid,desc' | 'name,asc' | 'name,desc' | 'description,asc' | 'description,desc' | 'version,asc' | 'version,desc' | 'purposeStatus,asc' | 'purposeStatus,desc' | 'purposeType,asc' | 'purposeType,desc' | 'consentLifeSpan,asc' | 'consentLifeSpan,desc' | 'implicitConsentLifeSpan,asc' | 'implicitConsentLifeSpan,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'createdBy,asc' | 'createdBy,desc' | 'lastModifiedBy,asc' | 'lastModifiedBy,desc' | 'publishedDate,asc' | 'publishedDate,desc' | 'retireOnDate,asc' | 'retireOnDate,desc' | 'publishedBy,asc' | 'publishedBy,desc' | 'externalReference,asc' | 'externalReference,desc' | 'defaultConsentStatus,asc' | 'defaultConsentStatus,desc'
Example:lastModifiedDate,asc

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

Response

OK - Successfully retrieved purpose versions

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.