We've detected that you are using the Brave browser. This site does not display correctly when the Brave Shields are enabled. Please set your Shields to Down.

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

All documentation updates should be made by submitting a DOC ticket, and changes to the APIs should be made by opening a merge request (MR) in the SARCH (sandbox) or DX (production) GitLab Repos.

Jump to Content

myOneTrust Developer Forum

SDK Reference Recipes API Reference Changelog

myOneTrust Developer Forum Log In Subscribe via RSS

API Reference

Log In Subscribe via RSS

SDK Reference Recipes API Reference Changelog

All

Pages

Start typing to search…

GETTING STARTED

OneTrust API Reference
Quick Start Guide: APIs
URL Variables for APIs & SDKs
OAuth 2.0

api resources

API Rate Limits
API Guides
Supported Languages and HTML Language Codes
OneTrust API Sunsetting & Deprecation Guidelines
- Deprecated APIs List
Understanding & Implementing Pagination

Platform - Access Management

Audit Records
- Get Audit Records for Login Historyget
- Get Audit Records for User's Profileget
OAuth Token
- Generate Access Tokenpost
Organizations
User Groups
User Groups V2
Users V2

Platform - Bulk Export

Bulk Export

Platform - Documents

Attachments
- Get File Locationget
- Upload Filepost

Platform - Integrations

System Credentials
- Create System Credentialpost
- Update System Credentialput
Workflows V2
- Export Workflowget
- Import Workflowpost

Platform - Inventory

Inventory Relationships V2
Relationship Management
- Create Relationshippost

Platform - Object Manager

Model Management
Object Attribute Management
Object Management
Object Relationship Management
Object Relationship Type Management
Object Task Management
Object Type Management
Project Management

Platform - Task Management

Tasks

Platform - User Provisioning

Groups V2
Resources V3
- Get Supported Resourcesget
- Get Supported Resource Typesget
SCIM Schemas V3
- Get List of Supported SCIM Schemasget
- Get SCIM Schemaget
Service Provider V3
- Get Service Provider Configurationget
User Groups V3
Users V2
Users V3

Consent & Preferences - Cookie Consent

Cookies
Domains
Scans
Scripts

Consent & Preferences - Cookie Consent (Swagger)

Categorizations
- Categorize Cookies by Domainpost
- Categorize Cookies by Domain and Cookie IDpost
Cookies
Scripts
Websites V2
- Add Websites to Scanpost
- Get List of Websitesget
Domains
- Create or Update Domain Grouppost

Consent & Preferences - Cookie Domain Data

Domain Data
- Get Domain Dataget

Consent & Preferences - Consent Interfaces

Preferences V2
- Get Data Subject's Preferencesget

Consent & Preferences - Consent Management Platform (CMP)

Banner
- Get Banner Dataget
Log Consent
- Log Consentpost
Preference Center
- Get Preference Center Dataget
UC Purposes
- Get Universal Consent Purposesget
Vendors
- Get IAB and Google Vendorsget

Consent & Preferences - Consent Receipts

Consent Receipts

Consent & Preferences - Cross-Device Consent

Preferences
- Get Data Subject's Preferencesget

Consent & Preferences - Mobile App Consent

Mobile App Data
- Get SDK Configurationget

Consent & Preferences - Policy & Notice Management

Privacy Notice V2

Consent & Preferences - Universal Consent & Preference Management (OAS)

Collection Points
Collection Points V2
- Get List of Collection Pointsget
- Create New Collection Point Versionpost
Consent Attachments
Consent Groups
Consent Rate Optimization
- Delete Cross Device Consents and Receiptsdel
Data Subject Groups
Data Subject Groups V4
Data Subjects
Data Subjects V2
Data Subjects V3
- Get List of Data Subjectsget
- Get Data Subjectget
Data Subjects V4
Deduplicate Data Subjects
Deletion Certificates
- Get List of Deletion Certificatesget
Magic Link Tokens
- Get List of Data Subject Tokensget
Magic Link Tokens V4
- Get Data Subject Tokenget
- Get List of Data Subject Tokensget
Preference Centers
Preference Centers V2
Purpose Preferences
Purposes
Purposes V2
- Get List of Purpose Versionsget
- Get Purposeget
Receipts
Receipts V2
- Get List of Receiptspost
Transactions
- Withdraw Consent on Behalf of a Data Subjectput
- Withdraw Data Subject's Consentget
Transactions V2
- Get List of Transactionspost

Data Use Governance - Data Catalog

Catalog Search V1
- Get Catalog Search Resultspost
- Get Search Fieldsget
Catalog Search V2
- Get Catalog Search Resultspost
Data Asset Attributes
- Get Data Asset Attributeget
- Get List of Data Asset Attributesget
Data Asset Management
- Delete Multiple Data Asset Tag Associationspost
- Delete Multiple Data Asset Term Associationspost
Data Assets
Glossaries
- Get List of Glossariesget
- Get Glossaryget
Tags
Terms

Data Use Governance - Data Discovery

Classification
Credentials
Data Sources
Installer
- Get List of Image tagsget
Scan Jobs
Scan Profiles

Data Use Governance - Data Discovery Worker Node

Custom Scan

Privacy Automation - Assessment Automation

Assessment Actions
Assessment Management
Assessments
Template

Privacy Automation - Assessment Automation (Swagger)

Assessment Actions

Privacy Automation - Data Mapping Automation

Inventory
Inventory Hierarchies
Inventory Relationships V1
Inventory Schema
Personal Data

Privacy Automation - Data Mapping Automation (Swagger)

Inventory
- Get Attribute Optionsget
Personal Data
- Get List of Data Classificationsget
- Get List of Data Elementsget

Privacy Automation - Data Subject Request (DSR) Automation

Request Queues
Resolutions
Results Summary
- Share Results Summarypost
Subtasks
Targeted Data Discovery
Verification Methods

Privacy Automation - Incident Management

Incidents

Tech Risk & Compliance - Audit Management

Audits
Workpapers

Tech Risk & Compliance - Compliance Automation

Initiatives

Tech Risk & Compliance - Enterprise Policy Management

Documents

Tech Risk & Compliance - Issues Management

Issues

Tech Risk & Compliance - IT Risk Management

Control Implementations
Control Links
- Link Controlspost
Controls
Entity Types
- Get List of Risk Entity Typesget
- Get List of Risk Entity Source Typesget
Evidence Task Implementations
Risk Actions
Risk Management
Risk Relationships
Risk Templates
- Get Risk Templateget
Risks
Threats
Vulnerabilities

Tech Risk & Compliance - Training

Training

Third-Party Management - Third-Party Risk Management

Contracts
Engagements

ESG Program Reporting & Disclosures

Carbon Management
Metric Details
- Get Metric Detailspost

Consent & Preferences - Cookie Consent
Scans

Scan Websites

post

https://{hostname}/api/cmp/v1/webscans

Use this API to start scans for the specified domains.

Language

Credentials

OAuth2

Client

Missing 1 required scope

URL

Getting Started

Quick Start Guide: APIs
SDK Reference
Recipes
Changelog

Knowledge Base

Articles
Documents
Developer Forum

Help Options

Help Options
View My Cases
System Status

OneTrust Seasonal Releases

OneTrust Seasonal Releases
Release Notes
Release Videos
Scheduled Maintenace
Talks Tech Podcast
Known Defect Database

Consumer Resources

Consumer Resources
Idea Exchange
OneTrust News
Hands-On Labs
OneTrust Partner List
Product Webinars
Training & Certifications

Privacy Matters

Our privacy center makes it easy to see how
we collect and use your information.

Your privacy

When we collect your personal information, we always inform you of your rights and make it easy for you to exercise them. Where possible, we also let you manage your preferences about how much information you choose to share with us, or our partners.

© 2025 OneTrust, LLC. All Rights Reserved.

Privacy Overview

Privacy Overview
Privacy Notice
Cookie Notice
Cookie List

Exercise Your Rights

Exercise Your Rights
Manage Your Comunication
Prefereces

👋 Hi there!

Start Learning. Start Building. Start Launching! 🚀

These resources can help you get started:

Did this page help you?

Please enter your feedback. Feedback submitted successfully!