Collection Points V2
Get List of Collection Points
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:
Response times may vary depending on pagination and cache state.
- 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.
- 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.
get/api/consentmanager/v2/collectionpoints
Query parameters
organizationIdstring uuid
The unique identifier of the Organization to filter by.
idstring uuid
Example:987b1f51-a538-122e-afc4-6b383c28eeb3
Unique identifier of a specific Collection Point to retrieve.
versioninteger
Example:1
Filter by specific version of the Collection Point.
status'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE'
Example:ACTIVE
Filter Collection Points by status.
pageinteger
The page number of the results (0-based).
sizeinteger
Example:20
The number of results per page.
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'
Example:createdDate,desc
Sorting criteria in the format: property,(asc|desc). Default sort order is descending. Multiple sort criteria are supported.
Response
OK - List of Collection Points retrieved successfully
Example response
{
"content": [
{
"id": "25d9ccac-db88-4d34-849c-3d602a629961",
"version": 2,
"name": "Web Form Collection Point",
"status": "ACTIVE",
"collectionPointType": "WEB_FORM",
"consentType": "FORMSUBMIT",
"description": "Collecting data for Marketing and Promotion Purposes",
"subjectIdentifier": "email",
"identifierDataElement": {
"guid": "21e0de87-d6ef-4b39-a54b-6d877698e3f6",
"numberOfLanguages": 3,
"createdDate": "2023-01-15T10:30:00Z",
"lastModifiedDate": "2023-01-20T14:45:30Z",
"canEdit": true,
"label": "Work Email",
"collectionPoints": 5,
"languages": [
{
"Name": "Work Email",
"DataElementOptions": [
{
"Id": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
"Label": "Option 1"
}
],
"Language": "en-us"
}
]
},
"createDate": "2018-03-22T20:55:40.237Z",
"firstReceiptOn": "2018-05-12T12:23:25.243Z",
"receiptCount": 563,
"hostedWebFormId": "123e4567-e89b-12d3-a456-426614174000",
"webFormUrl": "https://www.onetrust.com/collection-point",
"privacyPolicyUrl": "https://www.onetrust.com/privacy-notice",
"activationDate": "2018-03-15T12:00:20.123Z",
"organizationId": "92cf3a3a-09a9-4d04-b69d-ea5bb1db550a",
"redirectUrl": "https://www.onetrust.com/thank-you",
"iabVendorId": 13,
"lastSdkIntegrationDate": "2020-01-08T14:25:11.112Z",
"language": "en-us",
"responsibleUserId": "bc4836e2-c117-461b-a7a2-2b268c037a97",
"responsibleGroupId": "5466af43-ff42-4a39-8722-5a98e7981fc4",
"lastActivityDate": "2020-01-10T18:12:13.543Z",
"createdBy": "D452EC68-71C4-4935-9F17-5FD054365805",
"lastModifiedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
"publishedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
"dataElements": [
"First Name",
"Last Name",
"Email"
],
"noticesWithVersions": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Privacy Notice (v2.0)",
"url": "https://example.com/privacy-notice",
"privacyNoticeGuid": "223e4567-e89b-12d3-a456-426614174001",
"purposes": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Marketing Consent Form",
"version": 1,
"type": "CONSENT_FORM"
}
],
"privacyNoticeVersion": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Privacy Policy v2.1",
"version": 2,
"minorVersion": 1
},
"collectionPoint": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Marketing Consent Form",
"version": 1,
"type": "CONSENT_FORM"
}
}
],
"canCreateNewVersion": true,
"languages": [
"en-us",
"fr"
],
"preferenceCenter": {
"Id": "09ccd1b9-84a0-4bcb-a167-f761391ebffa",
"Name": "Email Communication Preferences",
"OrganizationName": "OneTrust",
"Template": "ENHANCED"
},
"purposes": [
{
"id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
"label": "Marketing Communications",
"description": "Collect customer emails for marketing purposes",
"status": "ACTIVE",
"version": 2,
"consentLifeSpan": 31536000,
"implicitConsentLifeSpan": 31536000,
"implicitConsentConfirmDesc": "I agree to the processing of my personal data for this purpose",
"purposeType": "STANDARD",
"parentPurposeId": "ba54eb25-90f0-4633-ab12-c7bf5afdd856",
"retireOnDate": "2025-12-31T23:59:59Z",
"createdBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
"createdDate": "2023-01-01T00:00:00Z",
"lastModifiedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
"lastModifiedDate": "2023-01-15T15:30:45Z",
"publishedBy": "304F7D36-75A2-4967-81A5-5A7D604C6A19",
"publishedDate": "2023-01-10T10:15:30Z"
}
]
}
],
"first": true,
"numberOfElements": 20,
"totalPages": 5,
"totalElements": 50,
"size": 20
}