myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS

Get List of Purposes for a Data Subject

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

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.

Query Params
string
deprecated

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

integer
≥ 0
Defaults to 0

Page number (0-based)

integer
1 to 100
Defaults to 20

Number of items per page

string
enum
Defaults to issuedAt,desc

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

Headers
string

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Updated 29 days ago

Language
Credentials
OAuth2
Missing 2 required scopes
URL
LoadingLoading…
Response
Choose an example:
application/json
*/*

Updated 29 days ago