OneTrust

OneTrust Data Subjects V4 API

The Data Subjects V4 APIs are used to manage data subject information, preferences, and consent records.

GitHub OpenAPI
Business capability
Privacy & Data Protection Management BC-130.50

Operations 11

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

DELETE /rest/api/consent/v4/data-subjects Delete a data subject · Delete Data Subject #
Ask an LLM
“Can I delete a data subject's consent profile entirely?”
“Is it possible to keep consent receipts when a data subject is deleted?”
Tell an agent destructive · confirm first
Delete data subject {identifier}.
Delete data subject {identifier}, retaining receipts: {retainReceipts}.
DELETE /rest/api/consent/v4/data-subjects/profiles Remove purposes from a data subject · Delete Purposes from Data Subjects #
Ask an LLM
“Can I remove just certain purposes from a data subject without deleting them?”
“Which purposes can be wiped from a consent profile?”
Tell an agent destructive · confirm first
Remove purposes {purposes} from data subject {identifier}.
Delete the purpose records {purposes} for {identifier}.
GET /rest/api/consent/v4/datasubjects List data subjects updated in a date range · Get List of Data Subjects #
Ask an LLM
“Which data subjects were updated between two dates?”
“Can I include do-not-call records when listing data subjects?”
Tell an agent
List data subjects updated from {fromDate} to {toDate}.
Show sorted data subjects changed between {fromDate} and {toDate}, sorted by {sort}.
GET /rest/api/consent/v4/datasubjects/basic-details Get a data subject's basic details · Get Data Subject #
Ask an LLM
“Can I get only a data subject's basic details, such as when it was created and last transacted?”
“Can I get just the basic details and data elements for one data subject?”
Tell an agent
Get basic details for data subject {identifier}.
Show the created date and data elements of {identifier}.
GET /rest/api/consent/v4/datasubjects/details Get a data subject's full consent details · Get Data Subject Details #
Ask an LLM
“Can I see everything about a data subject, including purposes and email link tokens?”
“Does the full data subject view include consent strings and attachments?”
Tell an agent
Get complete details for data subject {identifier}.
Fetch full details of {identifier} including consent groups {includeConsentGroups}.
GET /rest/api/consent/v4/datasubjects/ds-profiles List all purposes for one data subject · Get List of All Purpose Details by Data Subject #
Ask an LLM
“Which purposes has a given person interacted with, and what is each status?”
“Can I page through every purpose record for one data subject?”
Tell an agent
List all purpose details for data subject {identifier}.
Show every purpose status recorded for {identifier}.
GET /rest/api/consent/v4/datasubjects/profiles List purpose details across all data subjects · Get List of All Purpose Details for All Data Subjects #
Ask an LLM
“What is the maximum date range for pulling purpose details across all data subjects?”
“Can I filter everyone's purpose records by collection point or status?”
Tell an agent
List purpose details for all data subjects updated between {updatedSince} and {updatedUntil}.
Show sorted purpose records for purpose {purposeId} changed from {updatedSince} to {updatedUntil}.
GET /rest/api/consent/v4/datasubjects/profiles/unordered Bulk-pull unordered purpose details · Get Optimized List of All Purpose Details for All Data Subjects #
Ask an LLM
“Is there a faster, unsorted way to export purpose details for all data subjects?”
“Can I get an optimized unordered feed of purpose changes by status?”
Tell an agent
Pull the unordered purpose feed from {updatedSince} to {updatedUntil}.
Fetch optimized unsorted purpose records with status {status} since {updatedSince} until {updatedUntil}.
GET /rest/api/consent/v4/datasubjects/profiles/{purposeGuid} Get one purpose for a data subject · Get Purpose Details by Data Subject #
Ask an LLM
“What did a person consent to for one specific purpose, and when?”
“Can I check a single purpose's preferences for a data subject?”
Tell an agent
Get purpose {purposeGuid} details for data subject {identifier}.
Show the consent date for {identifier} on purpose {purposeGuid}.
POST /rest/api/consent/v4/datasubjects/search-by-element Search data subjects by a data element · Search Data Subjects by Data Element #
Ask an LLM
“Can I find data subjects by a data element like a phone number or customer ID?”
“Does the data element search support continuation tokens for big result sets?”
Tell an agent
Search data subjects where {dataElementName} equals {dataElementValue}.
Find the data subject whose data element {dataElementName} is {dataElementValue}.
GET /rest/api/consent/v4/datasubjects/unordered Bulk-pull unordered data subjects · Get Optimized List of Data Subjects #
Ask an LLM
“Is there a high-performance unsorted list of data subjects for a date range?”
“Can I skip sorting to export data subjects faster?”
Tell an agent
Pull the optimized unsorted data subject list from {fromDate} to {toDate}.
Export unordered data subjects updated since {fromDate} until {toDate}, {size} per page.

Documentation

📖
Documentation
https://developer.onetrust.com/onetrust/reference/attribute-management
📖
Documentation
https://developer.onetrust.com/onetrust/reference/activity-log
📖
Documentation
https://developer.onetrust.com/onetrust/reference/preferences-v2
📖
Documentation
https://developer.onetrust.com/onetrust/reference/banner
📖
Documentation
https://developer.onetrust.com/onetrust/reference/consent-receipts
📖
Documentation
https://developer.onetrust.com/onetrust/reference/applications
📖
Documentation
https://developer.onetrust.com/onetrust/reference/categorizations
📖
Documentation
https://developer.onetrust.com/onetrust/reference/domain-data
📖
Documentation
https://developer.onetrust.com/onetrust/reference/preferences
📖
Documentation
https://developer.onetrust.com/onetrust/reference/mobile-app-data
📖
Documentation
https://developer.onetrust.com/onetrust/reference/privacy-notice-v2
📖
Documentation
https://developer.onetrust.com/onetrust/reference/collection-points
📖
Documentation
https://developer.onetrust.com/onetrust/reference/catalog-search-v1
📖
Documentation
https://developer.onetrust.com/onetrust/reference/classification
📖
Documentation
https://developer.onetrust.com/onetrust/reference/custom-scan
📖
Documentation
https://developer.onetrust.com/onetrust/reference/carbon-management
📖
Documentation
https://developer.onetrust.com/onetrust/reference/audit-records
📖
Documentation
https://developer.onetrust.com/onetrust/reference/bulk-export
📖
Documentation
https://developer.onetrust.com/onetrust/reference/attachments
📖
Documentation
https://developer.onetrust.com/onetrust/reference/system-credentials
📖
Documentation
https://developer.onetrust.com/onetrust/reference/inventory-relationships-v2
📖
Documentation
https://developer.onetrust.com/onetrust/reference/model-management
📖
Documentation
https://developer.onetrust.com/onetrust/reference/tasks
📖
Documentation
https://developer.onetrust.com/onetrust/reference/groups-v2
📖
Documentation
https://developer.onetrust.com/onetrust/reference/assessment-actions
📖
Documentation
https://developer.onetrust.com/onetrust/reference/inventory
📖
Documentation
https://developer.onetrust.com/onetrust/reference/inventory-1
📖
Documentation
https://developer.onetrust.com/onetrust/reference/drop-management
📖
Documentation
https://developer.onetrust.com/onetrust/reference/incidents
📖
Documentation
https://developer.onetrust.com/onetrust/reference/document-controller
📖
Documentation
https://developer.onetrust.com/onetrust/reference/audits
📖
Documentation
https://developer.onetrust.com/onetrust/reference/initiatives
📖
Documentation
https://developer.onetrust.com/onetrust/reference/document-attachments
📖
Documentation
https://developer.onetrust.com/onetrust/reference/issues
📖
Documentation
https://developer.onetrust.com/onetrust/reference/control-implementations
📖
Documentation
https://developer.onetrust.com/onetrust/reference/training
📖
Documentation
https://developer.onetrust.com/onetrust/reference/contracts

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-data-subjects-v4-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-data-subjects-v4-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

onetrust-data-subjects-v4-api-openapi.yml Raw ↑ 
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 (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-data-subjects-v4-api-openapi.yml