Get List of Purposes

get deprecatedhttps://customer.my.onetrust.com/api/consentmanager/v1/purposes

Gets a paged list of Purposes. We strongly suggest using GET /v2/purposes instead, as this endpoint has been deprecated.

Responses

Response body

object

content

array of objects

content

object

ConsentLifeSpan

int64

The lifespan of the consent in seconds

CustomPreferences

array of objects

A list of the Purpose's Custom Preferences

CustomPreferences

object

CustomPreferenceOptions

array of objects

A list with the Custom Preferences' Options

CustomPreferenceOptions

object

Disabled

boolean

Whether Purpose Preference Option is disabled or not

string

Unique identifier identifying a Purpose Preference Option

Label

string

The Option label

string

Unique identifier of the Purpose and Custom Preference relation

Name

string

The Custom Preference name

Description

string

Description of the purpose of processing

ExpiryDateType

string

Date field considered for Purpose lifespan/expiry

LAST_TRANSACTION_DATE CONSENT_DATE

uuid

Globally unique identifier of the Purpose

Label

string

Name of the Purpose

Languages

array of objects

A list of the Purpose's Languages

Languages

object

Default

boolean

Whether this language is the default one for the Purpose

Description

string

The Purpose description

Language

string

The Purpose content language code

Name

string

The Purpose name

ParentPurposeId

uuid

Parent purpose guid

PurposeType

string

Type of the Purpose

STANDARD COOKIE IAB MOBILE NOTIFICATION_OPT_OUT

RetireOnDate

date-time

Retirement Date of the Purpose

Status

string

Status of the Purpose

DRAFT ACTIVE RETIRED

Topics

array of objects

A list of the Purpose's Topics

Topics

object

CanDelete

boolean

Whether this Topic can be deleted or not

uuid

The unique identifier of the Purpose and Topic relation

IntegrationKey

string

The Topic integration key (combination of Purpose and Topic names)

Name

string

The Topic name

Version

int64

Version of the Purpose

attributes

object

Custom Purpose Attributes configured in the Attribute Manager under Consent & Preference Management > Setup > Attribute Manager in the OneTrust application. If values are populated for the attribute they will be displayed in this field.

empty

boolean

first

boolean

last

boolean

number

int32

numberOfElements

int32

pageable

object

offset

int64

≥ 0

The number of results to exclude from the start of the list.

pageNumber

int32

≥ 0

The page number of the results.

pageSize

int32

0 to 1000

Defaults to 20

The number of results per page.

paged

boolean

This flag indicates whether the results were paged.

sort

object

unpaged

boolean

This flag indicates whether the results were not paged.

size

int32

sort

object

empty

boolean

This flag indicates whether sort criteria was left undefined.

sorted

boolean

This flag indicates whether the results were sorted.

unsorted

boolean

This flag indicates whether the results were not sorted.

totalElements

int64

totalPages

int32

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://customer.my.onetrust.com/api/consentmanager/v1/purposes?page=0&size=20' \
3
     --header 'accept: application/json'


xxxxxxxxxx
75
}
1
{
2
  "content": [
3
    {
4
      "ConsentLifeSpan": 7776000,
5
      "CustomPreferences": [
6
        {
7
          "CustomPreferenceOptions": [
8
            {
9
              "Disabled": false,
10
              "Id": "ca0fc41b-b28a-4335-804c-44d1f0f782ed",
11
              "Label": "Weekly"
12
            }
13
          ],
14
          "Id": "c4a57a38-3774-45ad-9fa4-dbc545542232",
15
          "Name": "Email Frequency"
16
        }
17
      ],
18
      "Description": "Collect customer emails for marketing purposes",
19
      "ExpiryDateType": "LAST_TRANSACTION_DATE",
20
      "Id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
21
      "Label": "Marketing Communications",
22
      "Languages": [
23
        {
24
          "Default": true,
25
          "Description": "Collect customer emails for marketing purposes",

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

200OK

429Too Many Requests For more information, see API Rate Limits.