Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Consent Groups

Get List of Consent Groups

Use this API to retrieve a list of all Consent Groups along with details such as the Consent Group ID, associated Purpose Rules, and the list of data subjects and/or Consent Groups within its hierarchal structure.

get/api/consent/v2/consent-groups

Query parameters

namestring

Name of the Consent Group

Response

Successfully retrieved list of Consent Groups.

emptyboolean

The flag to check if the entity is empty or not.

firstboolean

The flag to check if the entity is first entity or not.

lastboolean

The flag to check if the entity is last entity or not.

numberinteger

The number associated with the result.

numberOfElementsinteger

Total number of elements in the result.

totalPagesinteger

Total number of pages in the result list.

totalElementsinteger

Total number of elements in the result.

sizeinteger

Size of the result list.

Example response

{
  "content": [
    {
      "consentGroupId": "2a644966-fe93-4561-b71a-f0dda4396459",
      "name": "OneTrust Atlanta",
      "externalName": "onetrust_atlanta"
    }
  ],
  "first": true,
  "numberOfElements": 20,
  "totalPages": 5,
  "totalElements": 50,
  "size": 20
}