myOneTrustDeveloper ForumTechnology Partners
API Reference
Subscribe via RSS

Get List of Purposes

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

End of Support Notification

This API is now deprecated. Any customers leveraging this API are encouraged to use the Get List of Purpose Versions API. For more information, see OneTrust API Sunsetting & Deprecation Guidelines.

Use this API to retrieve a paged list of purposes.

Query Params
integer
≥ 0
Defaults to 0

Results page you want to retrieve (0-based).

integer
1 to 100
Defaults to 20

Number of records per page.

string
enum
Defaults to name,asc

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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