Get List of All Purpose Details for All Data Subjects

get

https://{hostname}/rest/api/consent/v4/datasubjects/profiles

Use this API to retrieve a list of all purpose details last updated between a specified date range for all data subjects.

🗒
Things to Know

The maximum date range that can be returned is 7 days.

Query Params

collectionPointId

uuid

The unique identifier of the collection point.

purposeId

uuid

The unique identifier of the purpose.

status

string

enum

The status of the purpose for the data subject.

updatedSince

date-time

required

The start of a date and time range used to filter results.

updatedUntil

date-time

required

The end of a date and time range used to filter results.

page

integer

≥ 0

Defaults to 0

The page number of the results.

size

integer

1 to 50

Defaults to 20

The number of results per page.

sort

string

enum

Defaults to lastUpdatedDate,desc

The sort criteria that dictates the order of the results.

Allowed:

Headers

requestContinuation

string

The token used to paginate a response if the number of records is more than a page.

Responses

400

Bad Request

500

Internal Server Error

200OK

401Unauthorized

403Forbidden

404Not Found

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