--- title: "Get List of Data Subjects" method: GET path: "/rest/api/preferences/v3/datasubject-profiles" tags: ["Data Subjects V3"] --- # Get List of Data Subjects `GET /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](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 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 parameters - `updatedSince` string, date-time - `updatedUntil` string, date-time - `collectionPointGuid` string, uuid - `purposeGuid` string, uuid - `page` integer - `size` integer - `sort` 'lastUpdatedDate,asc' | 'lastUpdatedDate,desc' ## Headers - `identifier` string - `dataElementName` string - `dataElementValue` string - `requestContinuation` string ## Response `200` List of data subjects retrieved successfully. - DSPreferneceCacheDataSubjectProfilesSliceDto - `content` DSPreferneceCacheDataSubjectProfilesDto[] - `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 - `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` DSPreferneceCacheDataSubjectProfilesPurposeDto[] โ€” 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 - `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 - `preferences` string[] โ€” A list containing the Purpose's Topics - `topics` DSPreferneceCacheDataSubjectProfileTopic[] โ€” A list containing the Purpose's Topics - `id` string, uuid โ€” Unique Identifier identifying a Purpose Topic - `name` string โ€” The Topic name - `Preferences` object โ€” A list containing the Purpose's Custom Preferences - `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 - `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` DSPreferneceCacheCollectionPointNoticeProfilesDto[] โ€” 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 - `privacyNoticeGuid` string, uuid โ€” The unique identifier of a embedded privacy notice - `type` 'LINKED' | 'EMBEDDED' โ€” The type of the collection point notice - `purposes` DSPreferneceCachePurposeSimpleDetailsDto[] โ€” The set of purposes linked to the collection point notice - `guid` string, uuid โ€” The unique identifier of the purpose - `name` string โ€” The name of the purpose - `privacyNoticeVersion` DSPreferneceCacheSimpleNameVersionDto - `guid` string, uuid โ€” The unique identifier of the entity - `name` string โ€” The name of the entity - `version` integer โ€” The version of the entity - `collectionPoint` DSPreferneceCacheSimpleNameVersionDto - `guid` string, uuid โ€” The unique identifier of the entity - `name` string โ€” The name of the entity - `version` integer โ€” The version of the entity - `testDataSubject` boolean โ€” Flag indicating if Data Subject is a test Data Subject - `dsAttachments` DSPreferneceCacheCosmosDsAttachment[] โ€” Documents attached to Data Subject - `attachmentId` string, uuid - `fileName` string - `uploadedBy` string - `uploadDate` string, date-time - `LinkToken` string โ€” The Data Subject magic link token - `latestGeoLocation` DSPreferneceCacheDataSubjectGeolocation - `dataSubjectId` string, uuid - `country` string - `state` string - `stateName` string - `receiptGuid` string, uuid - `number` integer โ€” The page number of the results. - `size` integer โ€” The number of results per page. - `pageable` DSPreferneceCachePageableObject - `offset` integer - `sort` DSPreferneceCacheSortObject - `empty` boolean - `unsorted` boolean - `sorted` boolean - `pageNumber` integer - `pageSize` integer - `unpaged` boolean - `paged` boolean - `last` boolean โ€” Flag indicating whether this is the last page or not. - `sort` DSPreferneceCacheSortObject - `empty` boolean - `unsorted` boolean - `sorted` boolean - `first` boolean - `numberOfElements` integer - `empty` boolean ## 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.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)