---
title: "Get List of Purposes for a Data Subject"
method: GET
path: "/api/consentmanager/v1/datasubjects/purposes"
tags: ["Data Subjects"]
deprecated: true
---

# Get List of Purposes for a Data Subject

`GET /api/consentmanager/v1/datasubjects/purposes`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consentmanager/v1/datasubjects/purposes`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`, `CONSENT_READ`

> **Deprecated.**

> ❗️ End of Support Notification
>
>  This API is now deprecated. Any customers leveraging this API are encouraged to use the [Get List of Data Subjects API](https://developer.onetrust.com/onetrust/reference/getdatasubjectprofileusingget). For more information, see [OneTrust API Sunsetting & Deprecation Guidelines](https://developer.onetrust.com/onetrust/reference/onetrust-api-sunsetting-deprecation-guidelines).

Use this API to retrieve a paged list of purposes for a data subject identifier.

## Query parameters

- `identifier` string
- `page` integer
- `size` integer
- `sort` 'id,asc' | 'id,desc' | 'issuedAt,asc' | 'issuedAt,desc' | 'withdrawalDate,asc' | 'withdrawalDate,desc' | 'collectionPointGuid,asc' | 'collectionPointGuid,desc' | 'purposeGuid,asc' | 'purposeGuid,desc' | 'status,asc' | 'status,desc'

## Headers

- `identifier` string

## Response `200`

OK - Successfully retrieved the list of purposes for the data subject.

- ConsentPreferencesUniversalConsentPreferenceManagDataSubjectByPurposeInformation
  - `DataSubjectId` string: The unique identifier of the Data Subject
  - `Purposes` ConsentPreferencesUniversalConsentPreferenceManagPurposeInformation[]: List of purpose information associated with the Data Subject
    - `Id` string, uuid: Unique identifier for the Purpose
    - `Label` string: Name of the Purpose version
    - `Topics` ConsentPreferencesUniversalConsentPreferenceManagTopicInformation[]: List of topics associated with the Purpose
      - `Id` string, uuid
      - `Name` string
    - `Transactions` ConsentPreferencesUniversalConsentPreferenceManagTransactionInformation[]: List of consent transactions related to the Purpose
      - `IssueDate` string, date-time
      - `CollectionPointId` string, uuid
      - `ReceiptId` string, uuid
      - `TransactionId` string, uuid
      - `Status` 'EXPIRED' | 'WITHDRAWN' | 'NO_CONSENT' | 'PENDING' | 'ACTIVE' | 'OPT_OUT' | 'ALWAYS_ACTIVE' | 'HARD_OPT_OUT' | 'EXTEND' | 'CHANGE_PREFERENCES' | 'NOT_OPT_OUT' | 'OPT_IN' | 'IMPLICIT'
      - `WithdrawalDate` string, date-time
      - `ExpiryDate` string, date-time
      - `Preferences` ConsentPreferencesUniversalConsentPreferenceManagPreferenceDetail[]
        - `TopicId` string, uuid
        - `TransactionType` string

## Other responses

- `201`: Created - The request was successful and a new resource was created.
- `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.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)