Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subject Groups V4

Get List of Data Subject Group Associations by Data Subject

Use this API to retrieve details about a data subject's associations with Data Subject Groups.

🗒 Things to Know

  • If the linkedIdentityGroupId parameter is passed, the response will include details for the data subject's association with the specified Data Subject Group. If not passed, the response will include details for the data subject's associations with all Data Subject Groups in which the data subject is a member.
get/rest/api/consent/v4/linkedidentitygroups

Query parameters

linkedIdentityGroupIdstring uuid

The unique identifier of the data subject group.

Headers

identifierstring required

The data subject identifier of the data subject.

Response

OK

idstring

The unique identifier of the data subject group.

namestring

The name of the data subject group.

identifierstring

The data subject identifier of the data subject.

isPrimaryboolean

This flag indicates whether the data subject identifier is the primary identifier associated with the data subject group.

addedDatestring date-time

The date and time that the data subject was added to the data subject group.

Example response

[
  {
    "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "name": "a2229953-b4b5-4042-8cb9-b78038cc4c41",
    "identifier": "example@otprivacy.com",
    "isPrimary": true,
    "addedDate": "2020-05-30T12:23:42.145Z"
  }
]