---
title: "Get List of Data Subject Groups"
method: GET
path: "/api/consentmanager/v2/linkedidentitygroups"
tags: ["Data Subject Groups"]
---

# Get List of Data Subject Groups

`GET /api/consentmanager/v2/linkedidentitygroups`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/consentmanager/v2/linkedidentitygroups`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `CONSENT`, `CONSENT_READ`

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.

## Query parameters

- `displayOrganizations` boolean
- `page` integer
- `size` integer
- `sort` 'lastModifiedDate,asc' | 'lastModifiedDate,desc' | 'lastUpdatedDate,asc' | 'lastUpdatedDate,desc' | 'expiryDate,asc' | 'expiryDate,desc' | 'addedDate,asc' | 'addedDate,desc' | 'createdDate,asc' | 'createdDate,desc'

## Headers

- `primaryDataSubjectIdentifier` string
- `primaryDataSubjectIdentifierType` string
- `requestContinuation` string

## Response `200`

OK - Successfully retrieved Data Subject Groups.

- ConsentPreferencesUniversalConsentPreferenceManagPageLinkedIdentityGroupDtoPage
  - `content` ConsentPreferencesUniversalConsentPreferenceManagLinkedIdentityGroupDtoPage[]: The list of items for the current page.
    - `id` string, uuid: Globally unique identifier of a Linked Identity Group
    - `numberOfDataSubjects` integer: The number of Data Subjects in a Linked Identity Group
    - `createdDate` string, date-time: Creation date of a Linked Identity Group
    - `lastModifiedDate` string, date-time: Last modified date of a Linked Identity Group
    - `primaryDataSubjects` ConsentPreferencesUniversalConsentPreferenceManagDataSubjectEntryPage[]: List of primary Data Subjects in the Linked Identity Group
      - `id` string, uuid: Unique identifier of the Data Subject
      - `identifier` string, required: The identifier value of the Data Subject
      - `identifierType` string, required: The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)
    - `organizations` string[]: Set of organization UUIDs associated with the linked identity group
    - `primaryDataSubjectId` string, 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
    - `isPrimary` boolean: Boolean flag that denotes if the Data Subject is the primary of the group
    - `groupName` string: The name of the linked identity group
    - `key` 'PRIMARY' | 'CHILD' | 'GROUP_NAME': The type of the linked identity group
  - `empty` boolean: The flag to check if the entity is empty or not.
  - `first` boolean: The flag to check if the entity is first entity or not.
  - `last` boolean: The flag to check if the entity is last entity or not.
  - `number` integer: The number associated with the result.
  - `numberOfElements` integer: Total number of elements in the result.
  - `pageable` ConsentPreferencesUniversalConsentPreferenceManagPageableObjectPage
    - `offset` integer
    - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObjectPage
      - `empty` boolean
      - `sorted` boolean
      - `unsorted` boolean
    - `pageNumber` integer
    - `pageSize` integer
    - `paged` boolean
    - `unpaged` boolean
  - `sort` ConsentPreferencesUniversalConsentPreferenceManagSortObjectPage
    - `empty` boolean
    - `sorted` boolean
    - `unsorted` boolean
  - `totalPages` integer: Total number of pages in the result list.
  - `totalElements` integer: Total number of elements in the result.
  - `size` integer: Size of the result list.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500`: Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management.md) - [All operations](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/consent-preferences-universal-consent-preference-management/revisions/fe4a0697ec9d?raw)