Get List of Data Subject Groups

get https://customer.my.onetrust.com/api/consentmanager/v2/linkedidentitygroups

Use this API to retrieve a list of all Data Subject Groups. The response will include the Data Subject Group ID, number of data subjects, and details of the primary data subjects in the group.

Recipes

⛓️

Retrieve Data Subject Consent for all Members of the Data Subject Group

Open Recipe

Responses

Response body

object

content

array of objects

content

object

createdDate

date-time

Creation date of a Linked Identity Group

groupName

string

The Group name for the linked identifier

uuid

Globally unique identifier of a Linked Identity Group

isPrimary

boolean

The identifier is primary or not

key

string

The linked identifier is PRIMARY or CHILD or GROUP_NAME

lastModifiedDate

date-time

Last modified date of a Linked Identity Group

numberOfDataSubjects

int64

The number of Data Subjects in a Linked Identity Group

organizations

array of uuids

organizations

primaryDataSubjectId

uuid

Globally unique identifier of the primary Data Subject

primaryDataSubjectIdentifier

string

The identifier value of the primary Data Subject

primaryDataSubjectIdentifierType

string

The identifier type of the primary Data Subject

primaryDataSubjects

array of objects

primaryDataSubjects

object

uuid

Unique identifier of the Data Subject

identifier

string

The identifier value of the Data Subject

identifierType

string

The identifier type of the Data Subject

first

boolean

last

boolean

number

int32

numberOfElements

int32

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/v2/linkedidentitygroups?page=0&size=20' \
3
     --header 'accept: application/json'


xxxxxxxxxx
53
}
1
{
2
  "content": [
3
    {
4
      "createdDate": "2022-07-27T15:33:58.967",
5
      "groupName": "404-867-5309",
6
      "id": "f151efd2-f5f7-46a0-b880-3b88291542de",
7
      "isPrimary": true,
8
      "key": null,
9
      "lastModifiedDate": "2022-07-27T15:33:58.967",
10
      "numberOfDataSubjects": 2,
11
      "organizations": [],
12
      "primaryDataSubjectId": "2db8877a-d118-49bf-9f68-afdfbc1ca4aa",
13
      "primaryDataSubjectIdentifier": "404-867-5309",
14
      "primaryDataSubjectIdentifierType": "Mobile",
15
      "primaryDataSubjects": [
16
        {
17
          "id": "2db8877a-d118-49bf-9f68-afdfbc1ca4aa",
18
          "identifier": "404-867-5309",
19
          "identifierType": "Mobile"
20
        }
21
      ]
22
    },
23
    {
24
      "createdDate": "2022-07-15T18:18:41.267",
25
      "groupName": "George P. Burdell",

OneTrust Internal Users: DO NOT MAKE ANY DIRECT CHANGES!

200OK

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