v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Data Subject Groups

Get Data Subject Group

Use this API to retrieve a single Data Subject Group by its unique identifier along with details such as the Data Subject Group ID and the list of data subjects within its group.

get/api/consentmanager/v2/linkedidentitygroups/{linkedIdentityGroupId}

Path parameters

linkedIdentityGroupIdstring uuid required

Example:3d8c79aa-5a14-48a4-b88d-f023913ec2ca

Unique identifier identifying a Data Subject Group.

Query parameters

displayOrganizationsboolean

Include organization information in the response.

Response

OK - Successfully retrieved Data Subject Group.

idstring uuid

Globally unique identifier of a Linked Identity Group

createdDatestring date-time

Creation date of a Linked Identity Group

groupNamestring

The name of the linked identity group

Example response

{
  "id": "b0a6b5da-4ea2-4a9f-a25a-fb3e212efc30",
  "createdDate": "2020-05-30T10:52:30.974Z",
  "primaryDataSubject": {
    "id": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f",
    "identifier": "example@otprivacy.com",
    "identifierType": "Email",
    "addedDate": "2020-05-30T12:23:42.145Z",
    "numberOfLinkedGroups": 2,
    "magicLinkToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "magicLinkTokenEncoded": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "organizations": [
      "550e8400-e29b-41d4-a716-446655440000"
    ]
  },
  "primaryDataSubjects": [
    {
      "id": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f",
      "identifier": "example@otprivacy.com",
      "identifierType": "Email",
      "addedDate": "2020-05-30T12:23:42.145Z",
      "numberOfLinkedGroups": 2,
      "magicLinkToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "magicLinkTokenEncoded": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "organizations": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "dataSubjects": [
    {
      "id": "c43a9190-ffd6-4be3-aeff-95b46d0fa59f",
      "identifier": "example@otprivacy.com",
      "identifierType": "Email",
      "addedDate": "2020-05-30T12:23:42.145Z",
      "numberOfLinkedGroups": 2,
      "magicLinkToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "magicLinkTokenEncoded": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "organizations": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "groupName": "Customer Group A"
}