Get List of Purpose Versions

get

https://{hostname}/api/consentmanager/v2/purposes

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.

Query Params

latestVersion

boolean

Defaults to false

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

includeRetired

boolean

Defaults to false

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

organization

uuid

Organization ID to filter purposes by.

includeCustomPreferences

boolean

Defaults to false

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

includeTopics

boolean

Defaults to false

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

fromLastModifiedDate

date-time

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

toLastModifiedDate

date-time

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

page

integer

≥ 0

Defaults to 0

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

size

integer

1 to 100

Defaults to 20

Number of records per page.

sort

string

enum

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK - Successfully retrieved purpose versions

429Too Many Requests. For more information, see API Rate Limits.