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

# Get List of Data Subjects

`GET /api/consentmanager/v2/datasubjects`

Use this API to retrieve a list of all data subjects. The response will include details for each data subject such as the associated data elements, data subject ID, and data subject identifier. By default, the response will return data subject details sorted in descending order of last modified date.

> 🗒 Things to Know
> 
> - 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.

> 🚧 
> 
> 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

- `page` integer
- `size` integer
- `updatedSince` string, date-time
- `updatedUntil` string, date-time
- `id` string, uuid
- `language` string
- `properties` string
- `includeDataSubjectsWithOutPurposeTransactions` boolean
- `isDNCInclude` boolean

## Headers

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

## Response `200`

OK - List of data subjects retrieved successfully.

- ConsentPreferencesUniversalConsentPreferenceManagDataSubjectSliceDtoV2
  - `content` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectDtoV2[]
    - `id` string, uuid — Unique identifier for the Data Subject
    - `identifier` string — The Data Subject's identifier (e.g., email, phone number)
    - `language` string — The preferred language code for the Data Subject
    - `lastUpdatedDate` string, date-time — The timestamp when the Data Subject's record was last updated
    - `dataElements` object — Map of data elements and their corresponding values for the Data Subject
    - `dataElementsMetaData` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectElementDtoV2[] — List of data elements with metadata for the Data Subject
      - `name` string, required — The name of the data element
      - `linked` boolean, required — Indicates whether this data element value is linked as an identifier
      - `value` object, required — The value of the data element. Can be a single value or an array of values.
      - `doNotCall` boolean — Indicates if a phone number is listed in FCC's Do Not Call registry
    - `linkToken` string — Token used for magic link authentication of the Data Subject
    - `createdDate` string, date-time — The timestamp when the Data Subject's record was created
    - `identifierType` string — The type of identifier used for the Data Subject
    - `testDataSubject` boolean — Indicates whether this is a test Data Subject
    - `doNotCall` boolean — Indicates if the Data Subject's phone number is on the FCC's Do Not Call list
  - `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)