--- title: "Get Data Subject" method: GET path: "/rest/api/preferences/v3/datasubjects/profile" tags: ["Data Subjects V3"] --- # Get Data Subject `GET /rest/api/preferences/v3/datasubjects/profile` ## Request - Base URL: `https://hostname` - URL: `https://hostname/rest/api/preferences/v3/datasubjects/profile` - Auth: OAuth 2 - Client credentials - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`, `CONSENT_READ` > ❗️ Migration Recommendation > > Please, do not adopt this API if you have not already done so. Continue to use the [Get List of Data Subjects](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget) V1 API or request access to have Data Subjects V4 APIs enabled. Use this API to retrieve a single data subject using the `identifer` header parameter. > 🗒 Things to Know > > - This API can also be used to retrieve the magic link token as `linkToken` in the response. > - This API will remain available during maintenance periods. > - This API is not designed to be used in workflows. ## Query parameters - `includeInstantLinkToken` boolean - `isDNCInclude` boolean ## Headers - `identifier` string, required ## Response `200` Data subject details retrieved successfully. - DSPreferneceCacheDataSubjectProfileDto - `id` string, uuid: Unique Identifier identifying a Data Subject - `language` string: The preferred language for the Data Subject - `identifier` string: The Data Subject identifier value - `linkToken` string: The Data Subject magic link token - `lastUpdatedDate` string, date-time: The date that the Data Subject record was last updated on - `createdDate` string, date-time: The date when the Data Subject record was created - `dataElements` DSPreferneceCacheDataSubjectElementDto[]: The Data Subject's data elements - `name` string: The Data Element name. - `value` object: The Data Element value. - `doNotCall` boolean: This attribute determines if a phone number is listed in FCC’s Do Not Call list. - `purposes` DSPreferneceCacheDataSubjectProfilePurposeDto[]: The Data Subject's profile Purposes - `id` string, uuid: Unique Identifier identifying a Purpose - `lastReceiptId` string, uuid: Unique Identifier identifying a Receipt - `name` string: The Purpose name - `version` integer: Version of the Purpose - `status` string: Status of the Purpose - `firstTransactionDate` string, date-time: The Date the first transaction was recorded against this Purpose - `lastTransactionDate` string, date-time: The Date the last transaction was recorded against this Purpose - `withdrawalDate` string, date-time: The Date the withdrawal transaction was recorded against this Purpose - `reactivationDate` string, date-time: Indicates the date and time on which a consent will be reactivated. This is set to snooze a purpose until the specified date and time. The consent remains snoozed until this date, then is automatically reactivated and becomes active again. - `consentDate` string, date-time: The Date the Data Subject consented to this Purpose - `expiryDate` string, date-time: The Date the Data Subject's consent expires for this Purpose - `totalTransactionCount` integer: The total number of Transactions recorded against this Purpose - `topics` DSPreferneceCacheDataSubjectProfileTopic[]: A list containing the Purpose's Topics - `id` string, uuid: Unique Identifier identifying a Purpose Topic - `name` string: The Topic name - `customPreferences` DSPreferneceCacheDataSubjectProfileCustomPreferenceDto[]: A list containing the Purpose's Custom Preferences - `id` string, uuid: Unique Identifier identifying the Custom Preference. - `name` string: The Custom Preference name. - `options` DSPreferneceCacheDataSubjectProfileCustomPreferenceOptionDto[]: List containing the Custom Preference's Options. - `Id` string, uuid: Unique Identifier identifying a Custom Preference Option - `name` string: The Option name - `lastTransactionCollectionPointId` string, uuid - `lastTransactionCollectionPointVersion` integer - `purposeNote` DSPreferneceCachePurposeNoteDto - `noteId` string, uuid: Unique identifier of the reason template - `noteType` 'UNSUBSCRIBE_REASON': The type of the note - `noteLanguage` string: The language of the note - `noteText` string: The actual text of the note - `isValidNote` boolean: Flag indicating if the note is a valid reason template - `groupEffectiveStatus` DSPreferneceCachePurposesGroupEffectiveStatusDto[]: A List of Effective Status of all purposes in consent group reference - `groupId` string, uuid: Unique identifier for identifying a Consent group - `effectiveStatus` string: Purpose status in a Consent Group - `lastUpdatedDate` string, date-time: Date/Time of the most recent interaction that resulted in an update for this Purpose to any of: Purpose version, Purpose Status, or Topic/Custom Preference selections - `lastInteractionDate` string, date-time: Date/Time of the most recent Data Subject interaction for this Purpose Receipt API - `attributes` object: Attributes attached to the purpose - `purposeAttachments` DSPreferneceCacheCosmosDsAttachment[]: Documents attached to Purpose - `attachmentId` string, uuid - `fileName` string - `uploadedBy` string - `uploadDate` string, date-time - `geolocation` DSPreferneceCacheDataSubjectGeolocation - `dataSubjectId` string, uuid - `country` string - `state` string - `stateName` string - `receiptGuid` string, uuid - `Notices` DSPreferneceCacheCollectionPointNoticeWithVersionDtoV1[]: The Data Subject's profile notices - `Id` string, uuid: The collection point notice unique identifier - `Name` string: The collection point notice name - `Url` string: The url to a linked privacy notice - `Guid` string, uuid: The unique identifier of a embedded privacy notice - `Type` 'LINKED' | 'EMBEDDED': The type of the collection point notice - `Purposes` DSPreferneceCachePurposeSimpleDetailsDtoV1[]: The set of purposes linked to the collection point notice - `Id` string, uuid: The unique identifier of the purpose - `Name` string: The name of the purpose - `PrivacyNoticeVersion` DSPreferneceCacheSimpleNameVersionDtoV1 - `Id` 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 version of the entity - `CollectionPoint` DSPreferneceCacheSimpleNameVersionDtoV1 - `Id` 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 version of the entity - `testDataSubject` boolean: Flag indicating if Data Subject is a test Data Subject - `instantLinkTokens` DSPreferneceCacheLinkToken[]: Instant access link tokens - `instantLinkToken` string - `dsAttachments` DSPreferneceCacheCosmosDsAttachment[]: Documents attached to Data Subject - `attachmentId` string, uuid - `fileName` string - `uploadedBy` string - `uploadDate` string, date-time - `doNotCall` boolean: This attribute determines if a phone number is listed in FCC’s Do Not Call list - `latestGeolocation` DSPreferneceCacheDataSubjectGeolocation - `dataSubjectId` string, uuid - `country` string - `state` string - `stateName` string - `receiptGuid` string, uuid - `additionalIdentifierInstantLinkTokens` object: Instant access link tokens for additional identifiers ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: Forbidden - `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.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)