Data Subjects V4
Search Data Subjects by Data Element
Use this API to search for data subjects based on a specific data element name and value.
🗒 Things to Know
- This API supports pagination with continuation tokens for large result sets.
post/rest/api/consent/v4/datasubjects/search-by-element
Request body
Example request
{
"dataElementName": "Email",
"dataElementValue": "test@example.com"
}Response
Successfully retrieved data subjects matching the search criteria
Example response
{
"data": [
{
"language": "en-us",
"identifier": "example@otprivacy.com",
"linkToken": "jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ=",
"createdDate": "2020-01-12T16:11:25.479Z",
"testDataSubject": true,
"id": "633ba071-61b0-485f-81a0-a2245777b432",
"lastUpdatedDate": "2020-01-12T16:11:25.479Z",
"dataElements": [
{
"name": "Work Email"
}
],
"purposes": [
{
"name": "Marketing Communications",
"version": 2,
"status": "ACTIVE",
"firstTransactionDate": "2020-02-12T13:56:32.621Z",
"lastTransactionDate": "2020-02-12T14:22:09.801Z",
"withdrawalDate": "2020-02-12T13:59:00.045Z",
"expiryDate": "2020-01-07T13:57:03.012Z",
"purposeNote": {
"noteId": "d1a8f6f2-781a-4b2b-b1db-07e25f1c9a94",
"noteLanguage": "en-us",
"noteText": "0e7ed8b7-a64d-4e38-a7ea-7c28dbdd5869"
},
"lastUpdatedDate": "2020-02-13T11:34:30.974Z",
"lastInteractionDate": "2020-01-05T11:34:30.974Z",
"id": "369a7e44-ac23-4b50-a6a8-91c9e4aa3007",
"lastReceiptId": "057f47e6-dc7a-47da-a1d3-5b17b5c75e54",
"consentDate": "2020-01-07T13:18:23.123Z",
"totalTransactionCount": 3
}
]
}
]
}