v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Personal Data

Get List of Data Subjects

Use this API to retrieve the list of all existing Data Subjects.

get/api/inventory/v2/data-subjects

Query parameters

filterstring

Optional filter string to search data subjects by name

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page (1..50)

sort'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

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

Response

idstring uuid required

Unique identifier of the entity

namestring required

Name of the entity

nameKeystring required

Translation key for the entity name

descriptionstring

Description of the entity

descriptionKeystring

Translation key for the entity description

source'SYSTEM' | 'USER' | 'IMPORTED'

Source of the data subject

visibleboolean

Example response

{
  "id": "43fd3a8d-3f6b-464e-bf43-3f0c6c592442",
  "name": "Financial Data",
  "nameKey": "financial_data_name",
  "description": "Contains financial information of customers",
  "descriptionKey": "financial_data_description",
  "source": "SYSTEM"
}