Get List of Data Subject Groups

get

https://{hostname}/api/consentmanager/v2/linkedidentitygroups

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 Params

displayOrganizations

boolean

Include organization information for Data Subject Groups

page

integer

≥ 0

Defaults to 0

Results page you want to retrieve (0..N).

size

integer

1 to 100

Defaults to 20

Number of records per page.

sort

string

enum

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Headers

primaryDataSubjectIdentifier

string

In order to retrieve a list of Linked Identity Groups whose primary identifier is equal to the primaryDataSubjectIdentifier header value

primaryDataSubjectIdentifierType

string

In order to retrieve a list of Linked Identity Groups whose primary identifier type is equal to the primaryDataSubjectIdentifierType header value

requestContinuation

string

Token for pagination

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK - Successfully retrieved Data Subject Groups.

429Too Many Requests. For more information, see API Rate Limits.