How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OneTrust Purposes API

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

OneTrust Purposes API is one of 138 APIs that OneTrust publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Purposes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{hostname}.

7 operations 6 paths 18 schemas 2 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.onetrust.com
Authentication
OAuth 2.0, OAuth 2.0, OAuth 2.0
License
Resource Areas
1

Authentication & Security 3

OneTrust Purposes API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2) using the clientCredentials flow, exposing 2 scopes. It supports OAuth 2.0 (ConsentAPI_OAUTH2) using the clientCredentials flow, exposing 2 scopes. It supports OAuth 2.0 (DSPreferneceCache_OAUTH2) using the clientCredentials flow, exposing 2 scopes.

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Purposes 7

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

GET
/api/consentmanager/v1/purposesdeprecated
Get List of Purposes
getPurposesUsingGET 3 params → 200400401403404429500
POST
/api/consentmanager/v1/purposes
Create Purpose
createPurposeUsingPOST 1 param body → 200400401403404429500
POST
/api/consentmanager/v1/purposes/{purposeGuid}
Create New Purpose Version
createNewPurposeVersionUsingPOST 1 param → 200400401403404429500
PUT
/api/consentmanager/v1/purposes/{purposeId}
Update Purpose
editPurposeUsingPUT 2 params body → 200400401403404429500
GET
/api/consentmanager/v1/purposes/{purposeId}/datasubjects
Get List of Data Subjects by Purpose
getDataSubjectsForPurposesUsingGET 4 params → 200400401403404429500
PUT
/api/consentmanager/v1/purposes/{purposeId}/publish
Publish Purpose
publishPurposeUsingPUT 2 params → 200400401403404429500
PUT
/api/consentmanager/v1/purposes/{purposeId}/retire
Retire Purpose
setRetirementUsingPUT 2 params → 200400401403404429500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto (25 properties), ConsentPreferences-UniversalConsentPreferenceManag_EditPurposeDto (23 properties), ConsentPreferences-UniversalConsentPreferenceManag_PurposeCreateDto (18 properties), ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDto (17 properties). Each schema is shown below with its type and property counts.

ConsentPreferences-UniversalConsentPreferenceManag_AttributeValueInformation
object
8 properties 1 required
ConsentPreferences-UniversalConsentPreferenceManag_PurposeCustomPreferenceDto
object
17 properties 4 required
ConsentPreferences-UniversalConsentPreferenceManag_PageableObject
object
6 properties
ConsentPreferences-UniversalConsentPreferenceManag_SortObject
object
3 properties
ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceLanguageDto
object
5 properties 2 required
ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionDto
object
6 properties
ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectForPurposeInformation
object
6 properties 2 required
ConsentPreferences-UniversalConsentPreferenceManag_PagePurposeDetailsDto
object
11 properties
ConsentPreferences-UniversalConsentPreferenceManag_PageDataSubjectForPurposeInformation
object
11 properties
ConsentPreferences-UniversalConsentPreferenceManag_PurposeDetailsDto
object
25 properties
ConsentPreferences-UniversalConsentPreferenceManag_PurposeTopicDto
object
4 properties
ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceInformation
object
3 properties 2 required
ConsentPreferences-UniversalConsentPreferenceManag_CustomPreferenceOptionsInformation
object
2 properties 2 required
ConsentPreferences-UniversalConsentPreferenceManag_TopicInformation
object
2 properties
ConsentPreferences-UniversalConsentPreferenceManag_AssociatedAttributeValueInformation
object
4 properties 1 required
ConsentPreferences-UniversalConsentPreferenceManag_PurposeLanguageDto
object
6 properties 2 required
ConsentPreferences-UniversalConsentPreferenceManag_PurposeCreateDto
object
18 properties 3 required
ConsentPreferences-UniversalConsentPreferenceManag_EditPurposeDto
object
23 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onetrust-purposes-api-openapi.yml Raw ↑

Other APIs OneTrust publishes across the network.

OneTrust Activity Log API
OneTrust Applications API
OneTrust Assessment Actions API
OneTrust Assessment Management API
OneTrust Assessments API
OneTrust Attachments API
OneTrust Attachments V4 API
OneTrust Attribute Management API
OneTrust Audit Records API
OneTrust Audits API
OneTrust Banner API
OneTrust Bulk Export API
Where this information came from

This is an independent, third-party profile of OneTrust Purposes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.