Get List of Transactions

post

https://{hostname}/api/consent/v2/transactions

Use this API to retrieve a list of all consent transactions. The response will include information about each transaction, the corresponding consent date, and details of the Purposes and the associated Purpose Preferences that the data subject has interacted with.

🗒
Things to Know

The timespan for the fromDate and toDate values must be 24 hours or less.

The collectionPointAttributes parameter will be returned as null when left blank during normal ingestion (API collection point, webform) and as {} when left blank during bulk import.

Query Params

fromDate

date-time

Retrieve transactions recorded after the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS

toDate

date-time

Retrieve transactions recorded up to the specified date. Formats accepted: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS

collectionPointGuid

uuid

UUID of the Collection Point

page

int32

≥ 0

Defaults to 0

Results page to be retrieved (0..N).

size

int32

1 to 50

Defaults to 20

Number of records per page (1..50).

sort

string

enum

Defaults to consentCreationDate,desc

Sorting criteria in the format: property,direction (where direction is asc or desc). Supported properties: consentCreationDate.

Allowed:

Body Params

requestContinuation

string

Request continuation token used to paginate. If the number of records in the response is more than a page, it returns a requestContinuation token in the response. This requestContinuation token should be passed to the next request's body to paginate.

nextMarker

string

Request continuation token used to paginate over historical receipts

Responses

400

Bad Request

500

Internal Server Error

200Successfully retrieved list of transactions

401Unauthorized

403Forbidden

404Not Found

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