---
title: "Get List of Data Subjects"
method: GET
path: "/rest/api/consent/v4/datasubjects"
tags: ["Data Subjects V4"]
---

# Get List of Data Subjects

`GET /rest/api/consent/v4/datasubjects`

Use this API to retrieve a list of data subjects that were last updated between the specified date range. The response will include basic details, such as each data subject’s identifier, created date, data elements, and last updated date.

> 🗒 Things to Know
> 
> - The maximum date range that can be returned is 7 days.

## Query parameters

- `fromDate` string, date-time, required
- `toDate` string, date-time, required
- `isDNCInclude` boolean
- `page` integer
- `size` integer
- `sort` 'lastModifiedDate,asc' | 'lastModifiedDate,desc'

## Headers

- `requestContinuation` string

## Response `200`

OK

- ConsentAPIDataSubjectResponseSliceDto
  - `content` ConsentAPIDataSubjectResponseDto[]
    - `identifier` string — The data subject identifier of the data subject.
    - `identifierType` string — The type of data subject identifier used for the data subject's identifier.
    - `language` string — The language set for the data subject.
    - `createdDate` string, date-time — The date and time that the data subject record was created.
    - `lastTransactionDate` string, date-time — The date and time that the last transaction for the data subject was written to the database.
    - `lastReceiptGuid` string, uuid — The unique identifier of the latest consent receipt for the data subject.
    - `testDataSubject` boolean — This flag indicates whether the data subject is used for testing purposes.
    - `dataElements` ConsentAPIDataSubjectElementResponseDto[] — The additional information about the data subject.
      - `name` string — The name of the data element.
      - `value` object — The value of the data element.
      - `doNotCall` boolean — This flag indicates whether the data subject's phone number is on the Federal Trade Commissions (FTC's) Do Not Call list.
      - `linked` boolean — This flag indicates whether the data element is linked to the data subject.
    - `latestGeoLocation` ConsentAPIDataSubjectGeolocationResponseDto
      - `dataSubjectId` string, uuid — The unique identifier of the data subject.
      - `receiptGuid` string, uuid — The unique identifier of the consent receipt for which geolocation details were sent.
      - `country` string — The country where the consent interaction occurred.
      - `state` string — The state code where the consent interaction occurred.
      - `stateName` string — The name of the state where the consent interaction occurred.
    - `consentGroups` string[] — The list of data subject group identifiers to which the data subject belongs.
    - `latestSource` ConsentAPIDataSubjectSourceResponseDto
      - `dataSubjectId` string, uuid — The unique identifier of the data subject.
      - `receiptGuid` string, uuid — The unique identifier of the consent receipt for which source details were sent.
      - `sourceType` string — The type of source that captured the consent interaction.
      - `sourceContent` string — The URL or identifier of the source where the consent interaction took place.
    - `id` string, uuid — Unique Identifier identifying a Data Subject
    - `lastUpdatedDate` string, date-time — The date that the Data Subject record was last updated on
    - `doNotCall` boolean — This attribute determines if a phone number is listed in FCC’s Do Not Call list
    - `notices` ConsentAPINoticeDetailResponseDto[] — The Data Subject notices.
      - `id` string, uuid — The unique identifier of the collection point notice.
      - `name` string — The name of the collection point notice.
      - `url` string — The URL where the collection point notice can be found.
      - `guid` string, uuid — The unique identifier of a embedded privacy notice.
      - `type` 'LINKED' | 'EMBEDDED' — The type of collection point notice.
      - `purposes` ConsentAPINameGuidPair[] — The details of the purposes linked to the collection point notice.
        - `guid` string, uuid — The unique identifier of the entity.
        - `name` string — The name of the entity.
      - `privacyNoticeVersion` ConsentAPIVersionedEntity
        - `guid` 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 minor version of the entity.
      - `collectionPoint` ConsentAPIVersionedEntity
        - `guid` 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 minor version of the entity.
    - `attachments` ConsentAPIDataSubjectAttachmentResponseDto[] — Documents attached to Data Subject
      - `attachmentId` string, uuid — The unique identifier of the file attached to the data subject record.
      - `fileName` string — The name of the file attached to the data subject record.
      - `uploadedBy` string — The name of the user who uploaded the file.
      - `uploadDate` string, date-time — The date and time on which the file was uploaded.
  - `number` integer — The page number of the results.
  - `size` integer — The number of results per page.
  - `pageable` ConsentAPIPageableObject
    - `offset` integer
    - `sort` ConsentAPISortObject
      - `empty` boolean
      - `sorted` boolean
      - `unsorted` boolean
    - `pageNumber` integer
    - `paged` boolean
    - `pageSize` integer
    - `unpaged` boolean
  - `last` boolean — Flag indicating whether this is the last page or not.
  - `sort` ConsentAPISortObject
    - `empty` boolean
    - `sorted` boolean
    - `unsorted` boolean
  - `first` boolean
  - `numberOfElements` integer
  - `empty` boolean
  - `requestContinuation` string — The token used to paginate a response if the number of records is more than a page.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `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)