---
title: "Get List of Data Subjects"
method: GET
path: "/api/consentmanager/v1/datasubjects/profiles"
tags: ["Data Subjects"]
---

# Get List of Data Subjects

`GET /api/consentmanager/v1/datasubjects/profiles`

Use this API to retrieve a list of all data subjects. The response will include details for each data subject such as data elements, purposes, associated topics, and purpose preferences. The response will also include relevant information about the latest Collection Point interactions and receipt IDs, along with the current status of consent for the purposes and preferences they have interacted with.

> 🗒 Things to Know
> 
> - It is critical that all queries include `properties=ignoreCount`. Not including `ignoreCount` will significantly decrease performance. If you need the count, we advise to only include it in the initial query, and not for subsequent page calls.
> - The values passed in the `properties` query parameter can change the response of this API. A fast response on large data sets can be obtained passing any of the following values: `linkTokens`, `ignoreCount`, `ignoreTopics`, `ignoreCustomPreferences`.
> - This API is not designed to be used in synchronous workflows. As an alternative, the [Gets preferences for a Data Subject](https://developer.onetrust.com/onetrust/reference/getpreferencesusingget) API can be called.
> - It is strongly recommended to pass the `requestContinuation` parameter returned in the response of this API in the next API request to paginate. Including it is crucial for better performance when dealing with multiple pages of data subject records. For more information, see [Understanding & Implementing Pagination](https://developer.onetrust.com/onetrust/reference/understanding-implementing-pagination).
> - When specifying a data subject identifier, only the primary identifier is supported. Additional identifiers cannot be used for search or filtering.

> 🚧 
> 
> Please note that the FTC Do Not Call List is updated once daily and not updated in real time. As such, there may be a possibility that a consumer's preferences may have changed and they may have opted out of receiving communication before the Do Not Call list gets refreshed. OneTrust is merely conveying information received from the FTC and is not responsible for compiling the lists.

## Query parameters

- `since` string, date-time
- `toDate` string, date-time
- `updatedSince` string, date-time
- `identifier` string
- `purposeGuid` string, uuid
- `collectionPointGuid` string, uuid
- `collectionPointName` string
- `properties` string
- `includeEffectiveStatus` boolean
- `linkedIdentityGroupId` string, uuid
- `includeConsentAttachments` boolean
- `isDNCInclude` boolean
- `includeDSWithNoOrg` boolean
- `includeGeolocation` boolean
- `page` integer
- `size` integer
- `sort` 'id,asc' | 'id,desc' | 'identifier,asc' | 'identifier,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'lastTransactionDate,asc' | 'lastTransactionDate,desc' | 'identifierType,asc' | 'identifierType,desc'

## Headers

- `identifier` string
- `dataElementName` string
- `dataElementValue` string
- `requestContinuation` string

## Response `200`

OK - List of data subjects retrieved successfully.

- ConsentPreferencesUniversalConsentPreferenceManagDataSubjectProfileSliceDto
  - `content` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectProfileDto[]
    - `Id` string, uuid — Unique identifier for the Data Subject
    - `Language` string — The preferred language code for the Data Subject
    - `Identifier` string — The Data Subject's primary identifier (e.g., email, phone number)
    - `LinkToken` string — Token used for magic link authentication of the Data Subject
    - `LastUpdatedDate` string, date-time — The timestamp when the Data Subject's profile was last updated
    - `CreatedDate` string, date-time — The timestamp when the Data Subject's profile was created
    - `DataElements` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectElementDto[] — List of data elements associated with the Data Subject
      - `Name` string, required — The name of the data element
      - `Value` object — The value of the data element. Can be a single value or an array of values.
      - `DoNotCall` boolean — Indicates if the phone number is listed in the FCC's Do Not Call registry
      - `Linked` boolean — Indicates if this data element is linked as an identifier for the Data Subject
    - `Purposes` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectProfilePurposeDto[] — List of purposes associated with the Data Subject's profile
      - `Id` string, uuid — Unique identifier for the Purpose
      - `LastReceiptId` string, uuid — Unique identifier for the most recent receipt associated with this Purpose
      - `Name` string — The name of the Purpose
      - `Version` integer — Version number of the Purpose
      - `Status` string — Current status of the Purpose (e.g., ACTIVE, WITHDRAWN, EXPIRED)
      - `FirstTransactionDate` string, date-time — The date and time when the first transaction was recorded for this Purpose
      - `LastTransactionDate` string, date-time — The date and time when the most recent transaction was recorded for this Purpose
      - `WithdrawalDate` string, date-time — The date and time when the Data Subject withdrew consent for this Purpose
      - `ConsentDate` string, date-time — The date and time when the Data Subject initially consented to this Purpose
      - `ExpiryDate` string, date-time — The date and time when the Data Subject's consent for this Purpose will expire
      - `TotalTransactionCount` integer — The total number of transactions recorded for this Purpose
      - `Topics` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectProfileTopic[] — List of topics associated with this Purpose
        - `Id` string, uuid, required — Unique identifier for the topic
        - `Name` string, required — The display name of the topic
        - `IsConsented` boolean, required — Indicates whether the data subject has given consent for this topic
      - `CustomPreferences` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectProfileCustomPreferenceDto[] — List of custom preferences associated with this Purpose
        - `Id` string, uuid, required — Unique identifier for the custom preference
        - `Name` string, required — The display name of the custom preference
        - `Options` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectProfileCustomPreferenceOptionDto[] — List of available options for this custom preference
          - `Id` string, uuid, required — Unique identifier for the custom preference option
          - `Name` string, required — The display name of the option
          - `IsConsented` boolean, required — Indicates whether the data subject has given consent for this specific option
      - `LastTransactionCollectionPointId` string, uuid — Unique identifier of the collection point used in the last transaction
      - `LastTransactionCollectionPointVersion` integer — Version of the collection point used in the last transaction
      - `PurposeNote` ConsentPreferencesUniversalConsentPreferenceManagPurposeNoteDto
        - `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` ConsentPreferencesUniversalConsentPreferenceManagPurposesGroupEffectiveStatusDto[] — List of effective statuses for all purposes in the same consent group
        - `GroupId` string, uuid
        - `EffectiveStatus` string
      - `LastUpdatedDate` string, date-time — Date and time of the most recent update to this Purpose, including changes to version, status, or preferences
      - `LastInteractionDate` string, date-time — Date and time of the most recent interaction with this Purpose through the Receipt API
      - `attributes` object — Additional attributes associated with the Purpose as key-value pairs
      - `Geolocation` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectGeolocationDto
        - `DataSubjectId` string, uuid — Unique identifier of the Data Subject associated with this geolocation data
        - `ReceiptGuid` string, uuid — Unique identifier of the receipt associated with this geolocation data
        - `Country` string — Two-letter country code where the Data Subject is located
        - `State` string — State or region code where the Data Subject is located
        - `StateName` string — Full name of the state or region where the Data Subject is located
        - `CreatedDate` string, date-time — The date and time when the geolocation data was recorded
    - `Notices` ConsentPreferencesUniversalConsentPreferenceManagCollectionPointNoticeWithVersionDtoV1[] — List of privacy notices associated with the Data Subject
      - `Id` string, uuid — The unique identifier of the collection point notice
      - `Name` string — The name of the collection point notice
      - `Url` string, uri — The URL to a linked privacy notice
      - `Guid` string, uuid — The unique identifier of the embedded privacy notice
      - `Type` 'LINKED' | 'EMBEDDED' — The type of the collection point notice
      - `Purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposeSimpleDetailsDtoV1[] — Set of purposes linked to the collection point notice
        - `Id` string, uuid
        - `Name` string
      - `PrivacyNoticeVersion` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersionDtoV1
        - `Id` string, uuid
        - `Name` string
        - `Version` integer
        - `MinorVersion` integer
      - `CollectionPoint` ConsentPreferencesUniversalConsentPreferenceManagSimpleNameVersionDtoV1
        - `Id` string, uuid
        - `Name` string
        - `Version` integer
        - `MinorVersion` integer
    - `TestDataSubject` boolean — Indicates whether this is a test Data Subject
    - `attachments` ConsentPreferencesUniversalConsentPreferenceManagConsentAttachmentResponseDto[] — List of attachments associated with the Data Subject's consent
      - `fileName` string — The name of the attached file
      - `attachmentId` string, uuid — Unique identifier for the consent attachment
    - `doNotCall` boolean
    - `LatestGeolocation` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectGeolocationDto
      - `DataSubjectId` string, uuid — Unique identifier of the Data Subject associated with this geolocation data
      - `ReceiptGuid` string, uuid — Unique identifier of the receipt associated with this geolocation data
      - `Country` string — Two-letter country code where the Data Subject is located
      - `State` string — State or region code where the Data Subject is located
      - `StateName` string — Full name of the state or region where the Data Subject is located
      - `CreatedDate` string, date-time — The date and time when the geolocation data was recorded
    - `LatestSource` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectSourceDto
      - `DataSubjectId` string, uuid — Unique identifier of the Data Subject associated with this source data
      - `ReceiptGuid` string, uuid — Unique identifier of the receipt associated with this source data
      - `type` string — The type of source that captured the consent interaction.
      - `content` string — The URL or identifier of the source where the consent interaction took place.
      - `CreatedDate` string, date-time — The date and time when the source data was recorded
  - `number` integer — The page number of the results.
  - `size` integer — The number of results per page.
  - `pageable` ConsentPreferencesUniversalConsentPreferenceManagPageableObject
    - `offset` integer
    - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObject
      - `empty` boolean
      - `unsorted` boolean
      - `sorted` boolean
    - `pageNumber` integer
    - `pageSize` integer
    - `paged` boolean
    - `unpaged` boolean
  - `last` boolean — Flag indicating whether this is the last page or not.
  - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObject
    - `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)