Get List of Collection Points

get

https://{hostname}/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 Params

dataElementGuid

uuid

The unique identifier of the Data Element.

organizationId

uuid

The unique identifier of an organization. This value can be obtained using the Retrieve Organization Structure API.

page

int32

≥ 0

Defaults to 0

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

size

int32

1 to 100

Defaults to 20

The number of records per page to return.

sort

string

enum

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

name

string

length ≤ 255

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

purposeGuid

uuid

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

collectionPointType

string

enum

Filter collection points by type.

consentType

string

enum

Filter collection points by the type of consent they capture.

Allowed:

status

string

enum

Filter collection points by their current status.

Allowed:

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200Successfully retrieved the list of collection points.

429Too Many Requests. For more information, see API Rate Limits.