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

Get Purpose

get
https://{hostname}/api/consentmanager/v2/purposes/

Use this API to retrieve a single Purpose by its unique identifier along with the associated attributes, Purpose Preferences, and created date.

πŸ—’

Things to Know

  • 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

Query Params
string
enum
Defaults to ACTIVE

The status of the Purpose to be retrieved (ACTIVE or DRAFT). By default, ACTIVE is returned.

Allowed:
integer
β‰₯ 1

Version number of the Purpose to be retrieved

Responses

400

Bad Request

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