---
title: "Search Data Subjects"
method: POST
path: "/api/consentmanager/v2/datasubjects/search"
tags: ["Data Subjects V2"]
---

# Search Data Subjects

`POST /api/consentmanager/v2/datasubjects/search`

Use this API to search for data subjects based on various criteria. The response will include details for each matching data subject such as the associated data elements, data subject ID, and data subject identifier.

> 🗒 Things to Know
> 
> - This API supports complex search criteria including filtering by data elements, purposes, and consent status.
> - For large result sets, use pagination to retrieve data in manageable chunks.
> - The response can be customized using the properties parameter to include or exclude certain data.

> 🚧 
> 
> 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
- `isDNCInclude` boolean

## Request body

- ConsentPreferencesUniversalConsentPreferenceManagDataSubjectSearchDto
  - `id` string, uuid — Filter Data Subject records by GUID
  - `identifier` string — Filter Data Subject records by identifier (e.g., email, phone number)
  - `updatedSince` string — Filter Data Subject records updated on or after this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
  - `updatedUntil` string — Filter Data Subject records updated on or before this date (format: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss)
  - `dataElements` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectElementSearchDto[] — Filter Data Subject records by data elements with specific names and values
    - `name` string — The name of the data element to search for
    - `value` string — The value to match against the specified data element name
  - `language` string — Filter Data Subject records by preferred language code
  - `includeCounts` boolean — When false, the response will not include the total record count (improves performance for large result sets)
  - `linkTokens` boolean — When true, includes link tokens in the response for magic link functionality
  - `linkedDS` boolean — When true, includes additional linked Data Subject information in the response
  - `ignoreDefaultSort` boolean — When true, overrides the default sorting by last modified date
  - `orgIds` string[] — Filter Data Subject records by organization IDs (internal use only)
  - `includeDataSubjectsWithOutPurposeTransactions` boolean — When true, includes Data Subjects that don't have any purpose transactions

## Response `200`

OK - Search results returned 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)