myOneTrustDeveloper ForumTechnology Partners
API Reference

Migrating to Data Subjects V4 Endpoints

Our latest Data Subjects highly available APIs focus on improving Data Subjects APIs by offering more targeted queries to increase efficiency by providing faster response times. The examples below show the new V4 endpoints and their equivalent versions. In addition, the required parameters for transitioning to the new version are provided along with the differences that the new endpoints present.

👍

For more information, click API titles to navigate to the corresponding V4 endpoint.

Get Data Subject

Required Parameters

  • identifier

Equivalents

curl --request GET \
     --url 'https://customer.my.onetrust.com/api/consentmanager/v1/datasubjects/profiles?size=20' \
     --header 'accept: application/json' \
     --header 'identifier: <IDENTIFIER>'

curl --request GET \
     --url https://customer.my.onetrust.com/api/consentmanager/v2/datasubjects \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

url --request GET \
     --url https://customer.my.onetrust.com/rest/api/preferences/v3/datasubjects/profile \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

What's new

In V4, this API provides the data subject details at the identity level (i.e., no consent level information), minimizing the data parsing process and improving performance speed.

Get Data Subject Details

Required Parameters

  • identifier

Equivalents

curl --request GET \
     --url 'https://customer.my.onetrust.com/api/consentmanager/v1/datasubjects/profiles?size=20' \
     --header 'accept: application/json' \
     --header 'identifier: <IDENTIFIER>'

curl --request GET \
     --url https://customer.my.onetrust.com/api/consentmanager/v2/datasubjects \
     --header 'accept: application/json'

url --request GET \
     --url https://customer.my.onetrust.com/rest/api/preferences/v3/datasubjects/profile \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

What's new

In V4, this API expands on the basic details of a data subject and can be used to retrieve more details of a data subject, including purpose information.

Get List of Data Subjects

Required Parameters

None

Equivalents

curl --request GET \
     --url https://customer.my.onetrust.com/api/consentmanager/v1/datasubjects/profiles \
     --header 'accept: application/json'

curl --request GET \
     --url https://customer.my.onetrust.com/api/consentmanager/v2/datasubjects \
     --header 'accept: application/json'

curl --request GET \
     --url https://customer.my.onetrust.com/rest/api/preferences/v3/datasubject-profiles \
     --header 'accept: application/json'

Get Purpose Details by Data Subject

Required Parameters

  • identifier
  • purposeGuid

Equivalents

curl --request GET \
     --url 'https://customer.my.onetrust.com/api/consentmanager/v1/datasubjects/profiles?size=20' \
     --header 'accept: application/json' \
     --header 'identifier: <IDENTIFIER>'

Not applicable

url --request GET \
     --url https://customer.my.onetrust.com/rest/api/preferences/v3/datasubjects/profile \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

What's new

This V4 API allows you to retrieve specific purpose information for a data subject.

Get List of All Purpose Details by Data Subject

Required Parameters

  • identifier

Equivalents

curl --request GET \
     --url 'https://customer.my.onetrust.com/api/consentmanager/v1/datasubjects/profiles?size=20' \
     --header 'accept: application/json' \
     --header 'identifier: <IDENTIFIER>'

curl --request GET \
     --url https://customer.my.onetrust.com/api/consentmanager/v2/datasubjects \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

url --request GET \
     --url https://customer.my.onetrust.com/rest/api/preferences/v3/datasubjects/profile \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

What's new

This V4 API is most similar to what V1 and V3 do, returning all purpose information for a given data subject.

Get List of All Purpose Details for All Data Subjects

Required Parameters

  • updatedSince
  • updatedUntil

Equivalents

Not applicable

Not applicable

Not applicable

What's new

This new V4 API allows you to extract purpose details by last collection point, purpose and/or status. This cannot be achieved using the V1 or V3 endpoints.

Get Data Subject Token

Required Parameters

  • identifier

Equivalents

curl --request GET \
     --url 'https://customer.my.onetrust.com/api/consentmanager/v1/linktokens?page=0&size=20' \
     --header 'accept: application/json' \
     --header 'identifier: IDENTIFIER'

Not applicable

Not applicable

What's new

This API allows you to retrieve the link token for a specific data subject.

Get List of Data Subject Tokens

Required Parameters

  • fromDate
  • toDate

Equivalents

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

Not applicable

Not applicable

What's new

This V4 API allows you to retrieve all link tokens. You must use requestContinuation token for pagination.

Get List of Data Subject Group Associations by Data Subject

Required Parameters

  • identifier

Equivalents

Not applicable

curl --request GET \
     --url 'https://customer.my.onetrust.com/api/consentmanager/v2/linkedidentitygroups?page=0&size=20' \
     --header 'accept: application/json' \
     --header 'primaryDataSubjectIdentifier: IDENTIFIER'

Not applicable

Get List of Data Subject Group Members

Required Parameters

  • linkedIdentityGroupId

Equivalents