ONonetrust
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

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/inventory/v2/data-subjects
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INTEGRATION
    • or OAuth 2
      Client credentials
      Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INVENTORY, INVENTORY_READ, INVENTORY_WRITE

Query parameters

objectTypestring
objectIdstring uuid
relationshipContextboolean
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

OK

OR

Example response

{
  "data": [
    {
      "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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.