--- title: "Get List of Purpose Versions" method: GET path: "/api/consentmanager/v2/purposes" tags: ["Purposes V2"] --- # Get List of Purpose Versions `GET /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 `

` and `

`HTML tags. These can be sanitized depending on your formatting needs. ## Query parameters - `latestVersion` boolean - `includeRetired` boolean - `organization` string, uuid - `includeCustomPreferences` boolean - `includeTopics` boolean - `fromLastModifiedDate` string, date-time - `toLastModifiedDate` string, date-time - `page` integer - `size` integer - `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' ## Response `200` OK - Successfully retrieved purpose versions - ConsentPreferencesUniversalConsentPreferenceManagPagePurposeVersionsGroupedByGuidSimple - `content` ConsentPreferencesUniversalConsentPreferenceManagPurposeVersionsGroupedByGuidSimple[] โ€” The list of items for the current page. - `purposeId` string, uuid, required โ€” Unique identifier of the purpose - `retireOnDate` string, date-time โ€” Date when the purpose will be retired - `createdDate` string, date-time, required โ€” Date when the purpose was created - `publishedBy` string โ€” ID of the user who last published the purpose - `publishedDate` string, date-time โ€” Date when the purpose was last published - `lastModifiedDate` string, date-time โ€” Date when the purpose was last modified - `versions` ConsentPreferencesUniversalConsentPreferenceManagPurposeDtoV2Simple[], required โ€” List of all versions of the purpose - `label` string, required โ€” Name or label of the purpose version - `description` string โ€” Detailed description of the purpose version - `status` 'DRAFT' | 'ACTIVE' | 'RETIRED', required โ€” Current status of the purpose version - `version` integer, required โ€” Version number of the purpose - `consentLifeSpan` integer โ€” Lifespan of consents recorded against this purpose version in seconds - `implicitConsentLifeSpan` integer โ€” Lifespan of implicit consents recorded against this purpose version in seconds - `implicitConsentConfirmDesc` string โ€” Description text for the implicit consent confirmation checkbox - `purposeType` 'STANDARD' | 'COOKIE' | 'IAB' | 'MOBILE' | 'NOTIFICATION_OPT_OUT', required โ€” Type of the purpose - `parentPurposeId` string, uuid โ€” Unique identifier of the parent purpose, if this is a child purpose - `retireOnDate` string, date-time โ€” Date when the purpose will be retired - `createdBy` string โ€” ID of the user who created the purpose - `createdDate` string, date-time โ€” Date and time when the purpose version was created - `lastModifiedBy` string โ€” ID of the user who last modified the purpose - `lastModifiedDate` string, date-time โ€” Date and time when the purpose version was last modified - `publishedBy` string โ€” ID of the user who published the purpose - `publishedDate` string, date-time โ€” Date and time when the purpose version was published - `detail` string โ€” URL to get the detailed information of this purpose version - `customPreferences` ConsentPreferencesUniversalConsentPreferenceManagPurposeCustomPreferenceDtoV2Simple[] โ€” List of custom preferences associated with this purpose - `id` string, required โ€” Unique identifier of the purpose-custom preference relationship - `name` string, required โ€” Name of the custom preference - `displayAs` 'BUTTONS' | 'CHECKBOXES', required โ€” Display type for rendering the custom preference in the UI - `customPreferenceOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDtoV2Simple[] โ€” List of available options for this custom preference - `id` string - `label` string - `languages` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceLanguageDtoV2Simple[] โ€” List of language-specific content for the custom preference - `name` string - `description` string - `language` string - `default` boolean - `options` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDtoV2Simple[] - `id` string - `label` string - `topics` ConsentPreferencesUniversalConsentPreferenceManagPurposeTopicDtoV2Simple[] โ€” List of topics associated with this purpose - `id` string, uuid, required โ€” Unique identifier of the purpose-topic relationship - `transactionType` string โ€” Type of transaction associated with the topic - `name` string, required โ€” Name of the topic - `integrationKey` string โ€” Integration key formed by combining purpose and topic names - `languages` ConsentPreferencesUniversalConsentPreferenceManagTopicLanguageDtoV2Simple[] โ€” List of language-specific content for the topic - `name` string - `language` string - `default` boolean - `canDelete` boolean โ€” Indicates whether this topic can be deleted - `organizations` string[] โ€” List of organization IDs associated with this purpose - `expiryDateType` 'LAST_TRANSACTION_DATE' | 'CONSENT_DATE' โ€” Type of date field used for calculating purpose lifespan/expiry - `enableGeolocation` boolean โ€” Flag indicating whether to capture the data subject's geolocation when consent is provided - `LastMajorVersion` integer - `VersionNotes` string - `IsMajorVersion` boolean - `HardOptOutDisplayFormat` 'HIDE' | 'LOCK' โ€” The format in which the purpose displays in a Trust Center when the consent status is Hard opt-out. Hard opt-out purposes can either be displayed but locked, or hidden. - `HardOptOutMessage` string โ€” The message to display with the purpose when the consent status is Hard opt-out. This message only displays when hardOptOutDisplayFormat is set to LOCK. - `attributes` object โ€” Additional attributes attached to the purpose - `empty` boolean โ€” The flag to check if the entity is empty or not. - `first` boolean โ€” The flag to check if the entity is first entity or not. - `last` boolean โ€” The flag to check if the entity is last entity or not. - `number` integer โ€” The number associated with the result. - `numberOfElements` integer โ€” Total number of elements in the result. - `pageable` ConsentPreferencesUniversalConsentPreferenceManagPageableObjectSimple - `offset` integer - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObjectSimple - `empty` boolean - `unsorted` boolean - `sorted` boolean - `pageNumber` integer - `pageSize` integer - `paged` boolean - `unpaged` boolean - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObjectSimple - `empty` boolean - `unsorted` boolean - `sorted` boolean - `totalPages` integer โ€” Total number of pages in the result list. - `totalElements` integer โ€” Total number of elements in the result. - `size` integer โ€” Size of the result list. ## 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.net/onetrust/apis/platform-access-management.md) ยท [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) ยท [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)