---
title: "Get List of Data Subjects"
method: GET
path: "/api/inventory/v2/data-subjects"
tags: ["Personal Data"]
---

# Get List of Data Subjects

`GET /api/inventory/v2/data-subjects`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/inventory/v2/data-subjects`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `INTEGRATION`
  - OAuth 2
    - Client credentials
    - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `INVENTORY`, `INVENTORY_READ`, `INVENTORY_WRITE`

Use this API to retrieve the list of all existing Data Subjects.

## Query parameters

- `objectType` string
- `objectId` string, uuid
- `relationshipContext` boolean
- `filter` string
- `page` integer
- `size` integer
- `sort` 'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

## Response `200`

OK

- union
  - OneTrustResponseListDataSubjectResponse
    - `data` DataSubjectResponse[]
      - `id` string, uuid, required: Unique identifier of the entity
      - `name` string, required: Name of the entity
      - `nameKey` string, required: Translation key for the entity name
      - `description` string: Description of the entity
      - `descriptionKey` string: Translation key for the entity description
      - `source` 'SYSTEM' | 'USER' | 'IMPORTED': Source of the data subject
      - `visible` boolean
    - `errors` object[]
    - `meta` OneTrustMetadata
      - `page` OneTrustPage
        - `first` boolean
        - `last` boolean
        - `number` integer
        - `size` integer
        - `totalElements` integer
        - `totalPages` integer
        - `sort` OneTrustSort[]
          - `direction` 'ASC' | 'DESC'
          - `property` string
  - DataSubjectResponse
    - `id` string, uuid, required: Unique identifier of the entity
    - `name` string, required: Name of the entity
    - `nameKey` string, required: Translation key for the entity name
    - `description` string: Description of the entity
    - `descriptionKey` string: Translation key for the entity description
    - `source` 'SYSTEM' | 'USER' | 'IMPORTED': Source of the data subject
    - `visible` boolean

## 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.dev/onetrust/apis/privacy-automation-data-mapping-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/privacy-automation-data-mapping-automation/revisions/daead5d9fad6?raw)