> ## Documentation Index
> Fetch the complete documentation index at: https://developer.onetrust.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List of Data Subject Groups

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.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Consent & Preferences - Universal Consent & Preference Management (OAS)",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Data Subject Groups",
      "description": "The Data Subject Groups APIs are used to manage groups of data subjects.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"
      },
      "x-displayName": "Data Subject Groups"
    }
  ],
  "paths": {
    "/api/consentmanager/v2/linkedidentitygroups": {
      "get": {
        "operationId": "getLinkedIdentityGroupsUsingGET",
        "summary": "Get List of Data Subject Groups",
        "description": "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.",
        "tags": [
          "Data Subject Groups"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"
        },
        "parameters": [
          {
            "name": "primaryDataSubjectIdentifier",
            "in": "header",
            "description": "In order to retrieve a list of Linked Identity Groups whose primary identifier is equal to the primaryDataSubjectIdentifier header value",
            "required": false,
            "schema": {
              "type": "string",
              "example": "user@example.com"
            }
          },
          {
            "name": "primaryDataSubjectIdentifierType",
            "in": "header",
            "description": "In order to retrieve a list of Linked Identity Groups whose primary identifier type is equal to the primaryDataSubjectIdentifierType header value",
            "required": false,
            "schema": {
              "type": "string",
              "example": "Email"
            }
          },
          {
            "name": "requestContinuation",
            "in": "header",
            "description": "Token for pagination",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "eyJpZCI6IjEyMzQ1Njc4OTAiLCJ0aW1lc3RhbXAiOjE2MDAwMDAwMDB9"
          },
          {
            "name": "displayOrganizations",
            "in": "query",
            "description": "Include organization information for Data Subject Groups",
            "required": false,
            "schema": {
              "type": "boolean",
              "example": false
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Results page you want to retrieve (0..N).",
            "schema": {
              "type": "integer",
              "example": 0,
              "default": 0,
              "minimum": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Number of records per page.",
            "schema": {
              "type": "integer",
              "example": 20,
              "default": 20,
              "maximum": 100,
              "minimum": 1
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
            "schema": {
              "type": "string",
              "example": "createdDate,desc",
              "enum": [
                "lastModifiedDate,asc",
                "lastModifiedDate,desc",
                "lastUpdatedDate,asc",
                "lastUpdatedDate,desc",
                "expiryDate,asc",
                "expiryDate,desc",
                "addedDate,asc",
                "addedDate,desc",
                "createdDate,asc",
                "createdDate,desc"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Successfully retrieved Data Subject Groups.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageLinkedIdentityGroupDto_Page"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": [
              "CONSENT",
              "CONSENT_READ"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Page": {
        "properties": {
          "id": {
            "description": "Unique identifier of the Data Subject",
            "type": "string",
            "format": "uuid",
            "example": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f"
          },
          "identifier": {
            "description": "The identifier value of the Data Subject",
            "type": "string",
            "example": "example@otprivacy.com"
          },
          "identifierType": {
            "description": "The type of identifier used for the Data Subject (e.g., Email, Phone, CustomID)",
            "type": "string",
            "example": "Email"
          }
        },
        "required": [
          "identifier",
          "identifierType"
        ]
      },
      "ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Page": {
        "properties": {
          "id": {
            "description": "Globally unique identifier of a Linked Identity Group",
            "type": "string",
            "format": "uuid",
            "example": "b0a6b5da-4ea2-4a9f-a25a-fb3e212efc30"
          },
          "numberOfDataSubjects": {
            "description": "The number of Data Subjects in a Linked Identity Group",
            "type": "integer",
            "format": "int64",
            "example": 6
          },
          "createdDate": {
            "description": "Creation date of a Linked Identity Group",
            "type": "string",
            "format": "date-time",
            "example": "2020-05-30T10:52:30.974Z"
          },
          "lastModifiedDate": {
            "description": "Last modified date of a Linked Identity Group",
            "type": "string",
            "format": "date-time",
            "example": "2020-05-30T12:23:42.145Z"
          },
          "primaryDataSubjects": {
            "description": "List of primary Data Subjects in the Linked Identity Group",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectEntry_Page"
            }
          },
          "organizations": {
            "description": "Set of organization UUIDs associated with the linked identity group",
            "type": "array",
            "items": {
              "type": "string",
              "format": "uuid",
              "description": "Set of organization UUIDs associated with the linked identity group"
            },
            "example": [
              "550e8400-e29b-41d4-a716-446655440000",
              "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
            ],
            "uniqueItems": true
          },
          "primaryDataSubjectId": {
            "description": "Globally unique identifier of the primary Data Subject",
            "type": "string",
            "format": "uuid",
            "example": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f"
          },
          "primaryDataSubjectIdentifier": {
            "description": "The identifier value of the primary Data Subject",
            "type": "string",
            "example": "example@otprivacy.com"
          },
          "primaryDataSubjectIdentifierType": {
            "description": "The identifier type of the primary Data Subject",
            "type": "string",
            "example": "Email"
          },
          "isPrimary": {
            "description": "Boolean flag that denotes if the Data Subject is the primary of the group",
            "type": "boolean",
            "example": false
          },
          "groupName": {
            "description": "The name of the linked identity group",
            "type": "string",
            "example": "Customer Group A"
          },
          "key": {
            "description": "The type of the linked identity group",
            "type": "string",
            "enum": [
              "PRIMARY",
              "CHILD",
              "GROUP_NAME"
            ]
          }
        }
      },
      "ConsentPreferences-UniversalConsentPreferenceManag_PageLinkedIdentityGroupDto_Page": {
        "type": "object",
        "properties": {
          "content": {
            "description": "The list of items for the current page.",
            "items": {
              "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkedIdentityGroupDto_Page"
            },
            "type": "array"
          },
          "empty": {
            "description": "The flag to check if the entity is empty or not.",
            "type": "boolean",
            "example": false
          },
          "first": {
            "description": "The flag to check if the entity is first entity or not.",
            "type": "boolean",
            "example": true
          },
          "last": {
            "description": "The flag to check if the entity is last entity or not.",
            "type": "boolean",
            "example": false
          },
          "number": {
            "description": "The number associated with the result.",
            "type": "integer",
            "format": "int32",
            "example": 0
          },
          "numberOfElements": {
            "description": "Total number of elements in the result.",
            "type": "integer",
            "format": "int32",
            "example": 20
          },
          "pageable": {
            "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_Page"
          },
          "sort": {
            "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Page"
          },
          "totalPages": {
            "description": "Total number of pages in the result list.",
            "type": "integer",
            "format": "int32",
            "example": 5
          },
          "totalElements": {
            "description": "Total number of elements in the result.",
            "type": "integer",
            "format": "int64",
            "example": 50
          },
          "size": {
            "description": "Size of the result list.",
            "type": "integer",
            "format": "int32",
            "example": 20
          }
        }
      },
      "ConsentPreferences-UniversalConsentPreferenceManag_PageableObject_Page": {
        "properties": {
          "offset": {
            "type": "integer",
            "format": "int64"
          },
          "sort": {
            "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Page"
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "paged": {
            "type": "boolean"
          },
          "unpaged": {
            "type": "boolean"
          }
        }
      },
      "ConsentPreferences-UniversalConsentPreferenceManag_SortObject_Page": {
        "properties": {
          "empty": {
            "type": "boolean"
          },
          "unsorted": {
            "type": "boolean"
          },
          "sorted": {
            "type": "boolean"
          }
        }
      }
    },
    "securitySchemes": {
      "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "CONSENT": "Consent Scope gives the user access to read/write operations",
              "CONSENT_READ": "Consent Read Scope gives the user read-only access"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  }
}
```