--- title: "Get Data Subject Details" method: GET path: "/rest/api/consent/v4/datasubjects/details" tags: ["Data Subjects V4"] --- # Get Data Subject Details `GET /rest/api/consent/v4/datasubjects/details` Use this API to retrieve complete details for a specific data subject. The response will include all of the data subject’s basic details, purpose details, and email link tokens. ## Query parameters - `includeConsentGroups` boolean - `includeAttachments` boolean - `includeNotices` boolean - `includeConsentStrings` boolean - `isDNCInclude` boolean ## Headers - `identifier` string, required ## Response `200` OK - ConsentAPIDataSubjectInformationResponseDto - `identifier` string — The data subject identifier of the data subject. - `identifierType` string — The type of data subject identifier used for the data subject's identifier. - `language` string — The language set for the data subject. - `createdDate` string, date-time — The date and time that the data subject record was created. - `lastTransactionDate` string, date-time — The date and time that the last transaction for the data subject was written to the database. - `lastReceiptGuid` string, uuid — The unique identifier of the latest consent receipt for the data subject. - `testDataSubject` boolean — This flag indicates whether the data subject is used for testing purposes. - `dataElements` ConsentAPIDataSubjectElementResponseDto[] — The additional information about the data subject. - `name` string — The name of the data element. - `value` object — The value of the data element. - `doNotCall` boolean — This flag indicates whether the data subject's phone number is on the Federal Trade Commissions (FTC's) Do Not Call list. - `linked` boolean — This flag indicates whether the data element is linked to the data subject. - `latestGeoLocation` ConsentAPIDataSubjectGeolocationResponseDto - `dataSubjectId` string, uuid — The unique identifier of the data subject. - `receiptGuid` string, uuid — The unique identifier of the consent receipt for which geolocation details were sent. - `country` string — The country where the consent interaction occurred. - `state` string — The state code where the consent interaction occurred. - `stateName` string — The name of the state where the consent interaction occurred. - `consentGroups` string[] — The list of data subject group identifiers to which the data subject belongs. - `latestSource` ConsentAPIDataSubjectSourceResponseDto - `dataSubjectId` string, uuid — The unique identifier of the data subject. - `receiptGuid` string, uuid — The unique identifier of the consent receipt for which source details were sent. - `sourceType` string — The type of source that captured the consent interaction. - `sourceContent` string — The URL or identifier of the source where the consent interaction took place. - `profiles` ConsentAPIDataSubjectProfileResponseDto[] - `id` string, uuid — Unique Identifier identifying a Purpose - `identifier` string — The data subject identifier of the data subject. - `lastReceiptId` string, uuid — Unique Identifier identifying a Receipt - `name` string — The Purpose name - `version` integer — Version of the Purpose - `status` string — The status of the purpose for the data subject. - `firstTransactionDate` string, date-time — The date and time that the first transaction was written to the database. - `lastTransactionDate` string, date-time — The date and time that the last transaction was written to the database. - `withdrawalDate` string, date-time — The date and time that the data subject withdrew consent for the purpose. - `consentDate` string, date-time — The date and time that the data subject gave their last active consent. - `expiryDate` string, date-time — The explicit expiration date after which the purpose is no longer valid and no further consent is collected against it. - `totalTransactionCount` integer — The total number of Transactions recorded against this Purpose - `topicsList` string[] — The list of topics associated with the purpose. - `topics` ConsentAPIDataSubjectProfileTopicResponseDto[] — The details of the topics for which transactions were recorded. - `id` string, uuid — Unique Identifier identifying a Purpose Topic - `name` string — The name of the topic. - `customPreferencesMap` object — The list of purpose preferences associated with the purpose. - `customPreferences` ConsentAPIDsProfileCustomPreferenceResponseDto[] — The details of the purpose preferences for which transactions were recorded. - `id` string, uuid — The unique identifier of the purpose preference. - `name` string — The name of the purpose preference. - `options` ConsentAPIDsProfileCustomPreferenceOptionResponseDto[] — List containing the Custom Preference's Options - `id` string, uuid — The unique identifiers of the purpose preference options. - `name` string — The name of the purpose preference options. - `lastTransactionCollectionPointId` string, uuid - `lastTransactionCollectionPointVersion` integer - `purposeNote` ConsentAPIPurposeNoteResponseDto - `noteId` string, uuid — The unique identifier of the reason template. - `noteType` 'UNSUBSCRIBE_REASON' — The type of reason template. - `noteLanguage` string — The ISO code for the language of the reason template. - `noteText` string — The text of the reason template. - `isValidNote` boolean — This flag indicates whether the note is a valid reason template. - `lastUpdatedDate` string, date-time — The date and time of the latest change to the data subject profile in the database.to any of: Purpose version, Purpose Status, or Topic/Custom Preference selections - `lastInteractionDate` string, date-time — The date and time of the data subject's last interaction with the purpose. - `attributes` object — The additional attributes associated with the purpose. - `geolocation` ConsentAPIDataSubjectGeolocationResponseDto - `dataSubjectId` string, uuid — The unique identifier of the data subject. - `receiptGuid` string, uuid — The unique identifier of the consent receipt for which geolocation details were sent. - `country` string — The country where the consent interaction occurred. - `state` string — The state code where the consent interaction occurred. - `stateName` string — The name of the state where the consent interaction occurred. - `attachments` ConsentAPIDataSubjectAttachmentResponseDto[] — Documents attached to Data Subject Profile - `attachmentId` string, uuid — The unique identifier of the file attached to the data subject record. - `fileName` string — The name of the file attached to the data subject record. - `uploadedBy` string — The name of the user who uploaded the file. - `uploadDate` string, date-time — The date and time on which the file was uploaded. - `source` ConsentAPIDataSubjectSourceResponseDto - `dataSubjectId` string, uuid — The unique identifier of the data subject. - `receiptGuid` string, uuid — The unique identifier of the consent receipt for which source details were sent. - `sourceType` string — The type of source that captured the consent interaction. - `sourceContent` string — The URL or identifier of the source where the consent interaction took place. - `linkTokens` ConsentAPIEmailLinkTokenResponseDto[] - `token` string — The data subject link token. This token can be appended to the preference center URL to form the preference center magic link. - `identifier` string — The data subject identifier of the data subject. - `createdDate` string, date-time — The date and time that the data subject link token was created. - `expiryDate` string, date-time — The date and time that the data subject link token expires. - `consentStrings` ConsentAPIConsentStringResponseDto[] - `type` string — The type of consent string. - `content` string — The content of the consent string. - `receivedDate` string, date-time — The date and time that the consent string was received. - `interactionDate` string, date-time — The date and time of the last interaction with the consent string. - `id` string, uuid — Unique Identifier identifying a Data Subject - `lastUpdatedDate` string, date-time — The date that the Data Subject record was last updated on - `doNotCall` boolean — This attribute determines if a phone number is listed in FCC’s Do Not Call list - `notices` ConsentAPINoticeDetailResponseDto[] — The Data Subject notices. - `id` string, uuid — The unique identifier of the collection point notice. - `name` string — The name of the collection point notice. - `url` string — The URL where the collection point notice can be found. - `guid` string, uuid — The unique identifier of a embedded privacy notice. - `type` 'LINKED' | 'EMBEDDED' — The type of collection point notice. - `purposes` ConsentAPINameGuidPair[] — The details of the purposes linked to the collection point notice. - `guid` string, uuid — The unique identifier of the entity. - `name` string — The name of the entity. - `privacyNoticeVersion` ConsentAPIVersionedEntity - `guid` string, uuid — The unique identifier of the entity. - `name` string — The name of the entity. - `version` integer — The version of the entity. - `minorVersion` integer — The minor version of the entity. - `collectionPoint` ConsentAPIVersionedEntity - `guid` string, uuid — The unique identifier of the entity. - `name` string — The name of the entity. - `version` integer — The version of the entity. - `minorVersion` integer — The minor version of the entity. - `attachments` ConsentAPIDataSubjectAttachmentResponseDto[] — Documents attached to Data Subject - `attachmentId` string, uuid — The unique identifier of the file attached to the data subject record. - `fileName` string — The name of the file attached to the data subject record. - `uploadedBy` string — The name of the user who uploaded the file. - `uploadDate` string, date-time — The date and time on which the file was uploaded. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview). - `500` — Internal Server Error --- [API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)