Get List of Data Subjects

get

https://{hostname}/rest/api/preferences/v3/datasubject-profiles

❗️
Migration Recommendation
Please, do not adopt this API if you have not already done so. Continue to use the Get List of Data Subjects V1 API or request access to have Data Subjects V4 APIs enabled.

Use this API to retrieve a list of all data subjects. Depending on the query or header parameter values passed in the request, the response will return specific details about data subjects, including relevant information about the latest Collection Point update.

🗒
Things to Know

This API can also be used to retrieve the magic link token as linkToken in the response.

The identifier header parameter can be used to return information for a single data subject.

This API is designed to remain available during maintenance periods.

This API is not designed to be used in workflows.

Query Params

updatedSince

date-time

The start of a date and time range used to filter data subject records/results that were last updated after the specified timestamp. The accepted format is yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

updatedUntil

date-time

The end of a date and time range used to filter data subject records/results that were last updated before the specified timestamp. The accepted format is yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

collectionPointGuid

uuid

UUID of the Collection Point.

purposeGuid

uuid

UUID of the Purpose. purposeGuid can be obtained using the Get A Paged List Of Purposes endpoint.

page

integer

≥ 0

Defaults to 0

Page number for pagination (zero-indexed).

size

integer

1 to 100

Defaults to 20

Number of records per page up to 2000 records per page. If a value above 2000 is used, only the first 2000 records will be returned.

sort

string

enum

Defaults to lastUpdatedDate,desc

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

Allowed:

Headers

identifier

string

Filter by data subject identifier.

dataElementName

string

Name of the data element to filter by.

dataElementValue

string

Value of the data element to filter by.

requestContinuation

string

RequestContinuation token which should be used to navigate to the next page.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200List of data subjects retrieved successfully.

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