Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Collection Points

Get List of Collection Points

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.

get/api/consentmanager/v1/collectionpoints

Query parameters

dataElementGuidstring uuid
Example:a1b2c3d4-e5f6-7890-1234-567890abcdef

Filter collection points by the unique identifier of an associated data element.

organizationIdstring uuid
Example:b2c3d4e5-f6a7-8901-2345-67890abcdef1

Filter collection points by the unique identifier of the owning organization.

pageinteger

The page number of the results to retrieve (0-based index).

sizeinteger

The number of records per page to return.

sort'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'status,asc' | 'status,desc' | 'version,asc' | 'version,desc'
Example:name,asc

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

namestring
Example:Newsletter Signup

Filter collection points by name (case-insensitive contains match).

purposeGuidstring uuid

Filter collection points by the unique identifier of an associated purpose.

collectionPointType'COOKIE' | 'WEB_FORM' | 'API' | 'MOBILE_SDK' | 'EMAIL' | 'CALL_CENTER' | 'PAPER' | 'IN_PERSON' | 'OTHER'

Filter collection points by type.

consentType'EXPLICIT' | 'IMPLIED' | 'NOT_APPLICABLE'

Filter collection points by the type of consent they capture.

status'DRAFT' | 'ACTIVE' | 'RETIRED' | 'INACTIVE' | 'ARCHIVED'

Filter collection points by their current status.

Response

Successfully retrieved the list of collection points.

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.