myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS
Start typing to search…

Get List of Data Subjects by Purpose

get
https://{hostname}/api/consentmanager/v1/purposes//datasubjects

Use this API to retrieve a list of data subjects by Purpose. The response will include details for each data subject such as the last transaction date, the transaction status for that Purpose, and Purpose Preferences they have interacted with.

πŸ—’

Things to Know

  • This API can be used as an alternative to the Get List of Data Subjects API when data subject records for a specific Purpose are required.
  • This API returns Purpose descriptions inside <p> and </p> HTML tags. These can be sanitized depending on your formatting needs.
Path Params
uuid
required

Unique identifier of the Purpose for which to retrieve data subjects

Query Params
date-time

Filter data subjects by last transaction date (ISO 8601 format: yyyy-MM-dd'T'HH:mm:ss)

string
enum

Filter data subjects by transaction status

Allowed:
boolean
Defaults to false

Include custom preference options in the response

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 4 months ago

Language
Credentials
OAuth2
Missing 2 required scopes
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 4 months ago