Get List of Data Subjects

❗️

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
date-time

Date from which to return records. Formats accepted are yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

date-time

Date until which to return records. Formats accepted are yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.

string

UUID of the Collection Point.

string

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

integer
0 to 2000
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.

array of strings

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

sort
Headers
string

Filter Data Subjects by data element name.

string

Filter Data Subjects by data element value.

string

Data Subject Identifier filter.

string

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

Responses

401
403
404

Language
Credentials
OAuth2