OneTrust

OneTrust Purposes API

The Purposes APIs are used to manage the reasons for which data is collected.

Documentation GitHub OpenAPI

Business capability

Privacy & Data Protection Management BC-130.50

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/consentmanager/v1/purposes List consent purposes (deprecated) · Get List of Purposes #

Ask an LLM

“Is there an older call that lists all consent purposes without grouping by version?”

“Can I still page through purposes with the deprecated list endpoint?”

Tell an agent

List purposes using the deprecated v1 list.

Show page {page} of purposes sorted by {sort} from the legacy endpoint.

POST /api/consentmanager/v1/purposes Create a consent purpose · Create Purpose #

Ask an LLM

“How do I create a new purpose for collecting consent?”

“What consent lifespan must I give a new purpose?”

Tell an agent

Create purpose {Name} described as {Description} with consent lifespan {ConsentLifeSpan}.

Draft a new {Type} purpose {Name}: {Description}, consent lifespan {ConsentLifeSpan}.

POST /api/consentmanager/v1/purposes/{purposeGuid} Create a new version of an active purpose · Create New Purpose Version #

Ask an LLM

“Can I draft changes to a purpose that's already active without touching the live version?”

“What status does a new purpose version start in?”

Tell an agent

Create a new draft version of purpose {purposeGuid}.

Start a new version of active purpose {purposeGuid}.

PUT /api/consentmanager/v1/purposes/{purposeId} Update a draft purpose · Update Purpose #

Ask an LLM

“Can I edit a purpose that is still in draft?”

“Why can't I update an active purpose directly?”

Tell an agent

Update draft purpose {purposeId} version {Version}: name {Name}, description {Description}, lifespan {ConsentLifeSpan}, status {Status}.

Rename draft purpose {purposeId} to {Name}.

GET /api/consentmanager/v1/purposes/{purposeId}/datasubjects List data subjects for a purpose · Get List of Data Subjects by Purpose #

Ask an LLM

“Who has consented to a given purpose?”

“Can I filter a purpose's data subjects by transaction status?”

Tell an agent

List data subjects for purpose {purposeId}.

Show data subjects of purpose {purposeId} with transaction status {transactionStatus}.

PUT /api/consentmanager/v1/purposes/{purposeId}/publish Publish a draft purpose · Publish Purpose #

Ask an LLM

“How do I make a draft purpose active?”

“Which version number do I need to publish a purpose?”

Tell an agent

Publish purpose {purposeId} version {version}.

Make version {version} of purpose {purposeId} active.

PUT /api/consentmanager/v1/purposes/{purposeId}/retire Retire a purpose · Retire Purpose #

Ask an LLM

“Can I schedule a purpose to be retired on a certain date?”

“What date is used if I retire a purpose without giving one?”

Tell an agent destructive · confirm first

Retire purpose {purposeId}.

Set purpose {purposeId} to retire on {date}.

Documentation

https://developer.onetrust.com/onetrust/reference/attribute-management

https://developer.onetrust.com/onetrust/reference/activity-log

https://developer.onetrust.com/onetrust/reference/preferences-v2

https://developer.onetrust.com/onetrust/reference/banner

https://developer.onetrust.com/onetrust/reference/consent-receipts

https://developer.onetrust.com/onetrust/reference/applications

https://developer.onetrust.com/onetrust/reference/categorizations

https://developer.onetrust.com/onetrust/reference/domain-data

https://developer.onetrust.com/onetrust/reference/preferences

https://developer.onetrust.com/onetrust/reference/mobile-app-data

https://developer.onetrust.com/onetrust/reference/privacy-notice-v2

https://developer.onetrust.com/onetrust/reference/collection-points

https://developer.onetrust.com/onetrust/reference/catalog-search-v1

https://developer.onetrust.com/onetrust/reference/classification

https://developer.onetrust.com/onetrust/reference/custom-scan

https://developer.onetrust.com/onetrust/reference/carbon-management

https://developer.onetrust.com/onetrust/reference/audit-records

https://developer.onetrust.com/onetrust/reference/bulk-export

https://developer.onetrust.com/onetrust/reference/attachments

https://developer.onetrust.com/onetrust/reference/system-credentials

https://developer.onetrust.com/onetrust/reference/inventory-relationships-v2

https://developer.onetrust.com/onetrust/reference/model-management

https://developer.onetrust.com/onetrust/reference/tasks

https://developer.onetrust.com/onetrust/reference/groups-v2

https://developer.onetrust.com/onetrust/reference/assessment-actions

https://developer.onetrust.com/onetrust/reference/inventory

https://developer.onetrust.com/onetrust/reference/inventory-1

https://developer.onetrust.com/onetrust/reference/drop-management

https://developer.onetrust.com/onetrust/reference/incidents

https://developer.onetrust.com/onetrust/reference/document-controller

https://developer.onetrust.com/onetrust/reference/audits

https://developer.onetrust.com/onetrust/reference/initiatives

https://developer.onetrust.com/onetrust/reference/document-attachments

https://developer.onetrust.com/onetrust/reference/issues

https://developer.onetrust.com/onetrust/reference/control-implementations

https://developer.onetrust.com/onetrust/reference/training

https://developer.onetrust.com/onetrust/reference/contracts

Specifications

https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-purposes-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/onetrust:onetrust-purposes-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Consent & Preferences - Universal Consent & Preference…
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: The Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform.
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:


# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-purposes-api-openapi.yml