Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subjects

Get List of Purposes for a Data Subject

❗️ 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. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.

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

get/api/consentmanager/v1/datasubjects/purposes

Query parameters

identifierstring
Example:user@example.com

The unique identifier of the data subject (email, phone number, etc.). Prefer using the header parameter.

pageinteger

Page number (0-based)

sizeinteger

Number of items per page

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'
Example:issuedAt,desc

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported

Headers

identifierstring
Example:user@example.com

The unique identifier of the data subject (email, phone number, etc.). Prefer using this header parameter over the query parameter.

Response

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

DataSubjectIdstring

The unique identifier of the Data Subject

Example response

{
  "DataSubjectId": "example@otprivacy.com",
  "Purposes": [
    {
      "Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
      "Label": "Marketing Communications"
    }
  ]
}