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

# Get List of Collection Points

`GET /api/consentmanager/v1/collectionpoints`

Use this API to retrieve a list of all Collection Points. The response will include relevant details for each Collection Point, including purposes, notices, data elements, and more.

## Query parameters

- `dataElementGuid` string, uuid
- `organizationId` string, uuid
- `page` integer
- `size` integer
- `sort` 'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'status,asc' | 'status,desc' | 'version,asc' | 'version,desc'
- `name` string
- `purposeGuid` string, uuid
- `collectionPointType` 'COOKIE' | 'WEB_FORM' | 'API' | 'MOBILE_SDK' | 'EMAIL' | 'CALL_CENTER' | 'PAPER' | 'IN_PERSON' | 'OTHER'
- `consentType` 'EXPLICIT' | 'IMPLIED' | 'NOT_APPLICABLE'
- `status` 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE' | 'ARCHIVED'

## Response `200`

Successfully retrieved the list of collection points.

- ConsentPreferencesUniversalConsentPreferenceManagPageCollectionPointDetailDto
  - `content` ConsentPreferencesUniversalConsentPreferenceManagCollectionPointDetailDto[] — The list of items for the current page.
    - `jwtToken` string — This property always returns null. To fetch the collection point's token, use the [Get collection point token API](https://developer.onetrust.com/onetrust/reference/gettokenusingget).
    - `noticesWithVersions` ConsentPreferencesUniversalConsentPreferenceManagCollectionPointNoticeWithVersionDto[] — List of Privacy Notices attached to the Collection Point
      - `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` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersion[], 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` ConsentPreferencesUniversalConsentPreferenceManagPrivacyNoticeVersionDtoV2
        - `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` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersion
        - `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.
    - `Id` string, uuid — Unique Identifier of the Collection Point
    - `Version` integer — Version of the Collection Point
    - `Name` string — Name 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' — Type of the Collection Point
    - `ConsentType` 'FORMSUBMIT' | 'EXPLICIT' | 'UNAMBIGUOUS' | 'OPTINCHECKBOX' | 'OPTOUTCHECKBOX' | 'SINGLETRIGGER' | 'CONDITIONALTRIGGER' | 'COOKIEBANNER' | 'UNCHECKOPTOUT' | 'CHECKOPTOUT' — Consent type of the Collection Point
    - `Status` 'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE' — Status of the Collection Point
    - `SubjectIdentifier` string — The Data Subject identifier of the Collection Point. Note: this string is the Data Element name when viewing details under the Consent & Preference Management module
    - `IdentifierDataElement` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementDto
      - `Id` string, uuid — Unique identifier identifying a Custom Data Element
      - `Label` string — The Custom Data Element name
      - `IsIdentifier` boolean — Whether the Data Element can be used as an identifier
      - `Languages` ConsentPreferencesUniversalConsentPreferenceManagDataElementLanguageDto[] — List containing the Data Element's translations
        - `Name` string — The Data Element name
        - `DataElementOptions` ConsentPreferencesUniversalConsentPreferenceManagCustomDataElementOptionDto[] — 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
      - `NumberOfLanguages` integer — The number of languages the Data Element has been translated in
      - `CreatedDate` string, date-time — The date that the Data Element was created on
      - `UpdatedDate` string, date-time — The date that the Data Element was last modified on
      - `CollectionPoints` integer — The number of Collection Points in which the Data Element is used
      - `CollectionPointsWithoutRetired` integer — The number of Collection Points excluding Retired Collection Point in which the Data Element is used
      - `totalActivePreferenceCenters` integer — The number of Active Preference Centers associated with the Data Element
      - `PreferenceCenters` integer — The number of Preference Centers associated with the Data Element
      - `LinkedDataSubjectElementExists` boolean — Boolean flag that denotes if the Custom Data Element is associated with Data Subject Elements
      - `canEdit` boolean — Whether the Data Element can be edited or not
      - `canDelete` boolean — Whether the Data Element can be deleted or not
      - `PIInfo` boolean — Boolean flag that denotes if the Custom Data Element belongs to PII
      - `Organizations` string[] — A list of Organization UUIDs
    - `CreateDate` string, date-time — Created Date of the Collection Point
    - `FirstReceiptOn` string, date-time — Date the first consent receipt was generated on for the Collection Point
    - `ReceiptCount` integer — Number of consent receipts issued from this Collection Point
    - `Description` string — Description of the Collection Point
    - `WebFormUrl` string — URL on which the Collection Point is hosted
    - `PrivacyPolicyUrl` string — URL that redirects to a Privacy Policy associated with this Collection Point
    - `ActivationDate` string, date-time — The Collection Point activation date
    - `OrganizationId` string, uuid — The unique Identifier of the Organization associated with the Collection Point. Note: this can be found in the url path when viewing Organization details under global settings
    - `DoubleOptIn` boolean — Whether Double Opt In (email confirmation) is enabled or not
    - `RedirectUrl` string — Used in Double Opt In confirmation email to redirect the Data Subject to another website after confirming their consent
    - `IABVendorId` integer — The IAB Vendor Id. Used for legacy mobile Collection Points
    - `NoConsentTransactions` boolean — Whether no consent transactions can be recorded against the collection point. For more information about consent transaction types and purpose statuses see this [article](https://my.onetrust.com/s/article/UUID-d4ed05a9-a999-f2cb-8272-610a5817b43f?topicId=0TO1Q000000bHgoWAE)
    - `LastSdkIntegrationDate` string, date-time — The date that the SDK Integration was last copied on
    - `Language` string — The Collection Point default language code
    - `Languages` string[] — List containing the Collection Point translations' language codes
    - `HostedSDK` boolean — Whether the SDK settings are published to external storage for quicker integration. This is enabled by default for all web form type collection points
    - `SendConsentEmail` boolean — Switch on or off the Consent Acknowledgement Email feature for a Collection Point
    - `PreferenceCenter` ConsentPreferencesUniversalConsentPreferenceManagPreferenceCenterSummaryDto
      - `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
    - `ResponsibleUserId` string, uuid — The Unique Identifier of the Responsible User. Note: this can be found in the url path when viewing Responsible User details under global settings
    - `ResponsibleGroupId` string, uuid — The Unique Identifier of the Responsible Group. Note: this can be found in the url path when viewing Responsible Group details under global settings
    - `LastActivityDate` string, date-time — Date on which the latest activity was recorded
    - `ConsentIntegration` boolean — Setting to fire the Data Subject Consent Updated integrations event. Note: we recommend using the `EnableNewConsentIntegration` setting to fire the Data Subject Profile Updated event instead
    - `EnableNewConsentIntegration` boolean — Setting to fire the Data Subject Profile Updated integrations event. For more information see this [article](https://my.onetrust.com/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)
    - `IsAuthenticationRequired` boolean — Setting to require authentication for a collection point. For more information see this [article](https://my.onetrust.com/s/article/UUID-b359a104-1900-9ac9-7765-ee08c8047f1d?topicId=0TO3q000000kIUHGA2)
    - `CreatedBy` string
    - `LastModifiedBy` string — Id of the user who last updated collection point
    - `ReconfirmActivePurpose` boolean — Used in conjunction with the double opt in feature. Will treat a returning data subject the same as a new one, and trigger the confirmation email event when re-consenting to the same purpose
    - `OverrideActivePurpose` boolean — Used in conjunction with the double opt in reconfirmation and purpose expiration features. This setting is enabled by default and can be turned off if it is desired for a purpose to remain in active status until expired if a data subject does not reconfirm their consent
    - `PublishedBy` string — Id of the user who last published the collection point
    - `IsDynamicCollectionPoint` boolean — Whether this is a dynamic collection point or not. For more information see this [article](https://my.onetrust.com/s/article/UUID-358c7e03-1d60-ff3b-e443-25d4283c7ac3?topicId=0TO3q000000kIWXGA2)
    - `DoiEmailToParent` boolean — When enabling the parental consent feature and double opt in emails, emails will be sent to the parent identifier by default instead of the child identifier. For more information about this preview feature see this [article](https://my.onetrust.com/s/article/UUID-f247abdd-fc02-413f-f5b8-17bff9dca4fa?topicId=0TO1Q000000ItSSWA0
    - `NewSdkIntegrationEnabled` boolean — Whether new sdk integration is enabled or not. SDK can be loaded in the <head> and a new script is no longer required for each form
    - `consentDOICancelOption` boolean — Setting for sending a cancellation for DOI CP
    - `DOISendConfirmationEmail` boolean — Double Opt In child setting to send the confirmation email or not. Note: the confirmation link is included in the Data Subject Profile Updated integrations event, which can be used to send custom email or sms messages
    - `Disabled` boolean — Whether this collection point is disabled or not
    - `EnablePublishEvent` boolean — Setting to fire the Collection Point Published integrations event. For more information see this [article](https://my.onetrust.com/s/article/UUID-58e8b9fb-0e47-5aca-713b-c2f26102d60c)
    - `EnablePrimaryIdentifier` boolean — Setting to enable primary identifier
    - `EnableCaptcha` boolean — Setting to enable captcha
    - `PrimaryIdentifierType` string — The primary Data Subject identifier type of the Collection Point
    - `EnableGeolocation` boolean — Setting to capture Data Subject's geolocation if they provide consent with a specific purpose. Note the geolocation feature is currently under preview
    - `EnableGeoLocationForDataElements` boolean — Setting to capture Data Subject's geolocation if they provide consent with a specific data element. Note the geolocation feature is currently under preview
    - `EnablePrefillIdentifier` boolean — Setting to capture whether to remember identifier in portal side
    - `RedirectOnFormSubmission` boolean — Setting to enable/disable the redirection feature on form submission
    - `DisableReports` boolean — Setting to stop consent Data Subject report for this CollectionPoint
    - `enablePurposeEvent` boolean — Setting to enable delta events for purposes in this CollectionPoint
    - `enableDataElementEvent` boolean — Setting to enable delta events for data elements in this CollectionPoint
    - `enableCustomPreferenceEvent` boolean — Setting to enable delta events for custom preference in this CollectionPoint
    - `DataElements` string[] — List containing the Data Elements associated with the Collection Point
    - `IdentifierTypes` string[] — Used in conjunction with the `AllowMultipleIdentifierTypes` setting. The List of Data Subject identifiers that can be used for the Collection Point
    - `AllowMultipleIdentifierTypes` boolean — Allow list of Data Subject identifier types for the Collection Point
    - `DataElementsTranslation` object — Data Element Translation
    - `CanCreateNewVersion` boolean — Whether a new version of the collection point can be created or not
    - `attributes` object — Attributes attached to the collection point
    - `HostedWebForm` ConsentPreferencesUniversalConsentPreferenceManagHostedWebFormDto
      - `Id` string, uuid — Unique identifier for the hosted web form
      - `Name` string, required — Name of the hosted web form
      - `WebFormData` object, required — JSON configuration data for the web form
      - `BrandingData` object — Branding configuration for the web form
      - `SdkVersion` string, required — Version of the SDK used for the web form
      - `PublishedLink` string, uri — URL to access the published version of the web form
      - `DraftLink` string, uri — URL to access the draft version of the web form
      - `VersionId` string, uuid — Unique identifier for the current version of the hosted web form
      - `DefaultLanguageTranslations` object — Default language translations for the web form
      - `PortalData` ConsentPreferencesUniversalConsentPreferenceManagHostedWebFormPortalData
        - `DefaultLanguage` string, required — Default language code for the web form portal
        - `SelectedLanguage` string[] — Set of language codes that are selected/available in the web form portal
        - `CustomTranslations` object, required — Custom translations for the web form portal. Nested map structure where the first key is the language code and the inner map contains key-value pairs of translation keys and their values.
      - `TestScriptGuid` string, uuid — Unique identifier for the test embedded script
      - `ProdScriptGuid` string, uuid — Unique identifier for the production embedded script
      - `previewId` string, uuid — Unique identifier for the web form draft version
      - `TestPublishVersion` string — Version number of the last test publish
      - `ProdPublishVersion` string — Version number of the last production publish
      - `supportedScriptVersion` string[] — List of supported script versions for the web form.
      - `NewSelectedLanguages` string[] — List of newly selected languages for the web form
      - `IntegrationUrls` string[] — A list of External Organization Ids.
      - `IntegrationSettings` object — Configuration settings for various integrations
      - `formTemplate` string — Template identifier for web form customization
    - `includeParameter` boolean — Setting to include parameter for DOI CP
    - `includeIdentifierParameter` boolean — Setting to include Identifier parameter for DOI CP
    - `CookieConsentUpdate` 'UPDATE_ALL' | 'SKIP_TRANSACTION' — Setting that governs cookie consent updates
    - `ParentIdentifierTypes` string[] — The List of parent Data Subject identifier types for the Collection Point. Note: this setting is used with the Consent on Behalf and Multiple Data Subject Identifiers preview features"
    - `DOIEmailIdentifier` string — Email identifier for which DOI needs to be sent
    - `AckEmailIdentifier` string — Identifier for which acknowledgement email needs to be sent
    - `PrefillIdentifier` string — Identifier which needs to be prefilled
    - `ShowDLNotification` boolean — Setting to indicate whether to show data localization URL change notification for this collection point
    - `Purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposeDto[] — The list of Purposes associated with the Collection Point
      - `Id` string, uuid — Unique Identifier of the Purpose
      - `Label` string — Name of the Purpose
      - `Description` string — Description of the Purpose
      - `Status` string — Status of the Purpose
      - `NewVersionAvailable` boolean — Whether there is a new version of the Purpose available
      - `Type` string — Type of the Purpose
      - `LifeSpan` integer — The lifespan of consents recorded against this Purpose in seconds
      - `ImplicitConsentConfirmDesc` string — Description of Implicit Consent Confirmation Checkbox
      - `PurposeCategory` ConsentPreferencesUniversalConsentPreferenceManagAttributeValueInformation
        - `id` string, uuid — Unique identifier for the attribute option
        - `value` string, required — Attribute value
        - `valueKey` string — Translation key used for localizing the value
        - `colorCode` string — Color code associated with the option. Used for score-based attributes.
        - `optionSelectionValue` string — Selection score value linked to the option. Used for score-based or numerical-based attributes.
        - `displayLabel` string — Display name for the option, used for external attributes managed by other systems
        - `associatedAttributeValueInformation` ConsentPreferencesUniversalConsentPreferenceManagAssociatedAttributeValueInformation[] — Associated attribute option information
          - `id` string, uuid — Unique identifier for the attribute option
          - `value` string, required — Attribute value
          - `valueKey` string — Translation key used for localizing the value
          - `colorCode` string — Color code associated with the option. Used for score-based attributes.
        - `disabled` boolean — Indicates whether this attribute option is currently disabled.
      - `Version` integer — Version of the Purpose
      - `ParentPurposeId` string, uuid — Parent purpose guid
      - `ExternalReference` string
      - `includeParameter` string — Setting to include parameter for DOI CP
      - `CreatedDate` string, date-time — Created Date of the Purpose
      - `UpdatedBy` string — Id of the user who updated the Purpose
      - `UpdatedDate` string, date-time — Last Modified Date of the Purpose
      - `PublishedBy` string — Id of the user who published the Purpose
      - `PublishedDate` string, date-time — Published Date of the purpose
      - `Topics` ConsentPreferencesUniversalConsentPreferenceManagPurposeTopicDto[] — A list of the Purpose's Topics
        - `Id` string, uuid — The unique identifier of the Purpose and Topic relation
        - `Name` string — The Topic name
        - `IntegrationKey` string — The Topic integration key (combination of Purpose and Topic names)
        - `CanDelete` boolean — Whether this Topic can be deleted or not
      - `CustomPreferences` ConsentPreferencesUniversalConsentPreferenceManagPurposeCustomPreferenceDto[] — A list of the Purpose's Custom Preferences
        - `Id` string, uuid, required — Unique identifier for the Custom Preference
        - `Name` string, required — The display name of the Custom Preference
        - `Description` string — Detailed description explaining the purpose and usage of this Custom Preference
        - `SelectionType` 'SINGLE_CHOICE' | 'MULTI_CHOICE' | 'SINGLE_CHOICE' | 'MULTI_CHOICE', required — Defines how options can be selected in this Custom Preference
        - `DisplayAs` 'BUTTONS' | 'CHECKBOXES' | 'BUTTONs' | 'CHECKBOXES' | 'DROPDOWN' | 'RADIO_BUTTONS', required — Specifies how the preference options should be displayed in the UI
        - `CreatedDate` string, date-time — Timestamp when the Custom Preference was created
        - `UpdatedDate` string, date-time — Timestamp when the Custom Preference was last updated
        - `NumberOfOptions` integer — Total number of available options for this Custom Preference
        - `Required` boolean — Indicates whether a response is mandatory for this Custom Preference
        - `NumberOfLanguages` integer — Number of languages this Custom Preference has been translated into
        - `DefaultLanguage` string — The default language code for this Custom Preference (BCP 47 format)
        - `Disabled` boolean — Indicates if this Custom Preference is currently disabled
        - `Options` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDto[] — List of available options for this Custom Preference
          - `Id` string, uuid — Unique Identifier identifying an Option
          - `Label` string — The Option label
          - `Order` integer — The order of the option, Starts from 0
          - `IsDefault` boolean — Whether the Option is default option or not
          - `CanDelete` boolean — Whether the Option can be deleted or not
          - `Disabled` boolean — Whether Custom Preference is disabled or not
        - `Languages` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceLanguageDto[] — List of language configurations for this Custom Preference
          - `Name` string, required — The Custom Preference name
          - `Description` string, required — The description of the Custom Preference
          - `Language` string — The Custom Preference content language code
          - `Default` boolean — Whether this language is the default one for the Custom Preference
          - `Options` ConsentPreferencesUniversalConsentPreferenceManagCustomPreferenceOptionDto[] — Options associated with a Custom Preference
            - `Id` string, uuid — Unique Identifier identifying an Option
            - `Label` string — The Option label
            - `Order` integer — The order of the option, Starts from 0
            - `IsDefault` boolean — Whether the Option is default option or not
            - `CanDelete` boolean — Whether the Option can be deleted or not
            - `Disabled` boolean — Whether Custom Preference is disabled or not
        - `Organizations` string[] — List of Organization IDs that have access to this Custom Preference
        - `TotalLinkedActivePurposes` integer — Count of active purposes that reference this Custom Preference
        - `PurposeCustomPreferenceId` string, uuid — Unique identifier of the Purpose and Custom Preference relation
      - `Organizations` string[] — A list of the Purpose's Organizations
      - `attributes` object — Custom Purpose Attributes configured in the Attribute Manager under Consent & Preference Management > Setup > Attribute Manager in the OneTrust application. If values are populated for the attribute they will be displayed in this field.
      - `PurposeIdWithVersion` string
      - `PurposeLanguages` ConsentPreferencesUniversalConsentPreferenceManagPurposeLanguageDto[] — List of languages for a Purpose
        - `Name` string, required — The Purpose name
        - `Description` string, required — The Purpose description
        - `Description of Implicit Purpose Confirmation checkbox` string — The Implicit Purpose Confirmation checkbox description
        - `Language` string — The Purpose content language code
        - `Default` boolean — Whether this language is the default one for the Purpose
        - `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.
      - `EnableGeolocation` boolean — Setting to capture DataSubject's geolocation if they provide consent to this specific Purpose
      - `LastMajorVersion` integer — The last major version number for this purpose
      - `VersionNotes` string — Notes or comments about this version
      - `IsMajorVersion` boolean — Indicates whether this version is a major release
      - `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.
  - `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` ConsentPreferencesUniversalConsentPreferenceManagPageableObject
    - `offset` integer
    - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObject
      - `empty` boolean
      - `unsorted` boolean
      - `sorted` boolean
    - `pageNumber` integer
    - `pageSize` integer
    - `paged` boolean
    - `unpaged` boolean
  - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObject
    - `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/versions/21de3aa0b170/schema)