---
title: "Get List of Collection Points"
method: GET
path: "/api/consentmanager/v2/collectionpoints"
tags: ["Collection Points V2"]
---

# Get List of Collection Points

`GET /api/consentmanager/v2/collectionpoints`

Use this API to retrieve a list of all collection points or retrieve a single collection point using the `id` query parameter. By default, the response will return details of all versions of a collection point with the active version listed first, but can be filtered using both the `version` and `status` query parameters.

> 🗒 Things to Know
> 
> #### Usage Guidelines
> 
> - **Server-side caching behavior:** To improve performance and reduce database load, this endpoint uses server-side caching with a 1‑hour TTL. Cached entries are automatically refreshed when collection point data is updated, ensuring responses remain current.
> - **Pagination and response caching:** This API is pageable, and a single page may include multiple collection points. As a result:
>   - End‑to‑end response caching is not always possible.
>   - When data for one collection point changes, cache eviction may require re-fetching other collection points included in the same cached page.
>   - Because of this, caching paginated responses is not efficient.
>   - To mitigate impact, caching is applied at a component level, rather than caching the entire API response payload.
> 
>   Response times may vary depending on pagination and cache state.
> - **Optimized Caching Use Cases:** Server-side caching is designed to be most effective when retrieving a specific collection point, querying by status, or querying by version. Broad, paginated list queries may experience variable performance depending on cache state.
> - **Client‑Side Caching Recommendations:** Collection point metadata changes infrequently, and clients are expected to implement client-side caching to ensure optimal performance:
>   - Cache metadata for 1–2 hours.
>   - Avoid calling this API per user interaction or transaction.
>   - Use cached metadata for downstream processing.
>   - Refresh cached data on expiry.

## Query parameters

- `organizationId` string, uuid
- `id` string, uuid
- `version` integer
- `status` 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE'
- `page` integer
- `size` integer
- `sort` 'id,asc' | 'id,desc' | 'name,asc' | 'name,desc' | 'status,asc' | 'status,desc' | 'version,asc' | 'version,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'activationDate,asc' | 'activationDate,desc' | 'collectionPointType,asc' | 'collectionPointType,desc'

## Response `200`

OK - List of Collection Points retrieved successfully

- ConsentPreferencesUniversalConsentPreferenceManagPageCollectionPointDtoV2DetailV2
  - `content` ConsentPreferencesUniversalConsentPreferenceManagCollectionPointDtoV2DetailV2[] — The list of items for the current page.
    - `id` string, uuid — Unique identifier of the collection point
    - `version` integer — Version number of the collection point
    - `name` string — Name of the collection point
    - `status` 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE' | 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE' — Current status of the collection point
    - `collectionPointType` 'WEB_FORM' | 'MOBILE_APPLICATION' | 'BULK_IMPORT' | 'API' | 'PREFERENCE_CENTER' | 'COOKIE' | 'TRUST_CENTER' | 'NOTIFICATION_OPT_OUT' | 'ADMIN_UPDATE' | 'HOSTED_WEB_FORM' | 'EMBEDDED_WEB_FORM' | 'WEB_FORM' | 'HOSTED_WEB_FORM' | 'EMBEDDED_WEB_FORM' | 'API' — Type of the collection point
    - `consentType` 'FORMSUBMIT' | 'EXPLICIT' | 'UNAMBIGUOUS' | 'OPTINCHECKBOX' | 'OPTOUTCHECKBOX' | 'SINGLETRIGGER' | 'CONDITIONALTRIGGER' | 'COOKIEBANNER' | 'UNCHECKOPTOUT' | 'CHECKOPTOUT' | 'FORMSUBMIT' | 'IMPLICIT' | 'EXPLICIT' — Type of consent mechanism used by the collection point
    - `description` string — Detailed description of the collection point's purpose
    - `subjectIdentifier` string — Identifier used to uniquely identify the data subject
    - `identifierDataElement` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementV2DetailV2
      - `guid` string, uuid, required — Unique identifier for the custom data element
      - `numberOfLanguages` integer — Number of language translations available for this data element
      - `createdDate` string, date-time — Timestamp when the data element was created
      - `lastModifiedDate` string, date-time — Timestamp when the data element was last modified
      - `canEdit` boolean — Indicates if the data element can be modified
      - `dataElementFields` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementFieldDetailV2
        - `dataElementType` 'USER_INPUT' | 'SELECTION' | 'EMAIL' | 'NUMBER' | 'DATE_PICKER' | 'COUNTRY' | 'STATE' | 'COUNTRY_CODE' | 'PHONE_NUMBER' | 'STATE_CODE', required — The type of the custom data element (e.g., TEXT, NUMBER, DATE, etc.)
        - `displayAs` 'DROPDOWN' | 'NONE' — Specifies how the data element should be displayed in the UI (e.g., as a text field, dropdown, radio buttons, etc.)
        - `dataElementOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementOptionDtoV2DetailV2[] — List of available options for this data element. Only applicable for choice-based elements like dropdowns or radio buttons.
          - `id` string, uuid
          - `label` string
      - `label` string, required — The display name/label of the custom data element
      - `isIdentifier` boolean — Indicates if this data element can be used as an identifier
      - `collectionPoints` integer — Number of collection points where this data element is being used
      - `languages` ConsentPreferencesUniversalConsentPreferenceManagDataElementLanguageDtoDetailV2[] — List of language-specific translations for this data element
        - `Name` string — The Data Element name
        - `DataElementOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementOptionDtoDetailV2[] — List of options available for this data element in the specified language
          - `Id` string, uuid — Unique identifier for the custom data element option
          - `Label` string, required — Display text for the option
        - `Language` string — The Data Element translation language code
    - `createDate` string, date-time — Timestamp when the collection point was created
    - `firstReceiptOn` string, date-time — Timestamp when the first consent receipt was generated for this collection point
    - `receiptCount` integer — Total number of consent receipts generated from this collection point
    - `hostedWebFormId` string, uuid — Unique identifier of the hosted web form associated with this collection point
    - `webFormUrl` string, uri — URL where the collection point is hosted
    - `privacyPolicyUrl` string, uri — URL that redirects to the Privacy Policy
    - `activationDate` string, date-time — Timestamp when the collection point was activated
    - `organizationId` string, uuid — Unique identifier of the organization that owns this collection point
    - `doubleOptIn` boolean — Indicates if double opt-in (email confirmation) is required for this collection point
    - `redirectUrl` string, uri — URL to redirect to after double opt-in confirmation
    - `iabVendorId` integer — IAB Vendor ID for mobile collection points
    - `noConsentTransactions` boolean — Indicates if transactions without explicit consent should be recorded
    - `lastSdkIntegrationDate` string, date-time — Timestamp when the SDK integration was last updated
    - `language` string — Default language code for the collection point
    - `hostedSDK` boolean — Indicates if the settings are published to external storage for optimized performance
    - `showWarning` boolean
    - `sendConsentEmail` boolean — Indicates if a consent acknowledgement email should be sent
    - `responsibleUserId` string, uuid — Unique identifier of the user responsible for this collection point
    - `responsibleGroupId` string, uuid — Unique identifier of the group responsible for this collection point
    - `lastActivityDate` string, date-time — Timestamp of the most recent activity on this collection point
    - `warningReasons` string[] — Set of warning reasons associated with the collection point
    - `consentIntegration` boolean — Indicates if consent events should be sent to third-party integrations
    - `enableNewConsentIntegration` boolean — Indicates if the new consent integration is enabled
    - `isAuthenticationRequired` boolean — Indicates if authentication is required to access this collection point
    - `createdBy` string — Identifier of the user who created the collection point
    - `lastModifiedBy` string — Identifier of the user who last modified the collection point
    - `reconfirmActivePurpose` boolean — Indicates if reconsent is required for active purposes
    - `publishedBy` string — Identifier of the user who last published the collection point
    - `dataElements` string[] — List of data elements associated with the collection point
    - `jwtToken` object — JWT token data for authentication and authorization
    - `noticesWithVersions` ConsentPreferencesUniversalConsentPreferenceManagCollectionPointNoticeWithVersionDtoDetailV2[] — List of notices with their version information
      - `id` string, uuid, required — The unique identifier of the collection point notice.
      - `name` string, required — The name of the notice as it appears in the collection point.
      - `url` string, uri — The URL where the full notice content can be accessed, if applicable.
      - `privacyNoticeGuid` string, uuid, required — The unique identifier of the privacy notice this collection point notice is associated with.
      - `type` 'LINKED' | 'EMBEDDED', required — The type of the collection point notice, indicating its purpose or category.
      - `purposes` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersionDetailV2[], required — Set of purposes associated with this notice, including their names and versions.
        - `id` string, uuid, required — The unique identifier of the entity
        - `name` string, required — The display name of the entity
        - `version` integer, required — The version number of the entity
        - `type` string — The type of the entity (optional, used for categorization)
      - `privacyNoticeVersion` ConsentPreferencesUniversalConsentPreferenceManagPrivacyNoticeVersionDtoV2DetailV2
        - `id` string, uuid — Unique identifier of the privacy notice version
        - `name` string — Name of the privacy notice version
        - `version` integer — Major version number of the privacy notice
        - `minorVersion` integer — Minor version number of the privacy notice (used for patch versions)
      - `collectionPoint` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersionDetailV2
        - `id` string, uuid, required — The unique identifier of the entity
        - `name` string, required — The display name of the entity
        - `version` integer, required — The version number of the entity
        - `type` string — The type of the entity (optional, used for categorization)
      - `noticeType` 'PRIVACY_NOTICE' | 'DIGITAL_POLICY' — The type of notice, which may provide additional categorization beyond the collection point notice type.
    - `canCreateNewVersion` boolean — Indicates if a new version of the collection point can be created
    - `newSdkIntegrationEnabled` boolean — Indicates if the new SDK integration is enabled
    - `disabled` boolean — Indicates if the collection point is disabled
    - `languages` string[] — List of language codes for which translations are availablel
    - `preferenceCenter` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCenterSummaryDtoDetailV2
      - `Id` string, uuid — Unique Identifier identifying the Preference Center
      - `Name` string — The Preference Center name
      - `OrganizationName` string — The Organization's name
      - `Template` 'ORIGINAL' | 'ENHANCED' | 'MULTIPAGE' — The Preference Center template type
    - `attributes` object — Additional attributes associated with the collection point
    - `purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposeDetailDtoV2DetailV2[] — The list of Purposes associated with the Collection Point. Each purpose contains detailed information including its status, consent model, and other relevant attributes.
      - `id` string, uuid, required — Unique identifier 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
      - `receiptInclusionAttributes` object — Attributes that should be included in the receipt
  - `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` ConsentPreferencesUniversalConsentPreferenceManagPageableObjectDetailV2
    - `offset` integer
    - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObjectDetailV2
      - `empty` boolean
      - `unsorted` boolean
      - `sorted` boolean
    - `pageNumber` integer
    - `pageSize` integer
    - `paged` boolean
    - `unpaged` boolean
  - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObjectDetailV2
    - `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)