---
title: "Get personal data configuration"
method: GET
path: "/api/dataentities/{dataEntityName}/personalData"
tags: ["Personal data"]
---

# Get personal data configuration

`GET /api/dataentities/{dataEntityName}/personalData`

## Request

- Base URL: `https://apiexamples.vtexcommercestable.com.br`
- URL: `https://apiexamples.vtexcommercestable.com.br/api/dataentities/{dataEntityName}/personalData`
- Auth: one of:
  - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken`
  - API key in header `VtexIdclientAutCookie`

Retrieves the personal data configuration for a data entity, including the list of fields flagged as personal data and the field used to identify the data subject.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `dataEntityName` string, required

## Headers

- `Accept` string, required

## Response `200`

OK

- PersonalDataRequest: Configuration of personal data fields for a data entity.
  - `Fields` string[], required: Names of fields that contain personal data. These fields are stored with encryption and special data residency, and are returned masked by default when retrieving documents.
  - `SubjectIdField` string, required: Name of the field whose value identifies the data subject (owner of the personal data) in each document. Required for compliance with data subject requests such as the right to be forgotten. Every document saved in this entity must contain this field.

## Other responses

- `403`: Forbidden
- `404`: Not Found The data entity does not have personal data configuration.

## Changes

- **2026-10-09** `4d580ec5be53`: 1 info
  - endpoint added
- **2026-05-14** `6d3f8010fa54`: 1 breaking
  - api path removed without deprecation
- **2026-04-08** `4d580ec5be53`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vtex/apis/master-data-api-v2/changes/api/dataentities/:dataEntityName/personalData/get.md)

---

[API](https://skmtc.dev/vtex/apis/master-data-api-v2.md) - [All operations](https://skmtc.dev/vtex/apis/master-data-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/master-data-api-v2/revisions/4d580ec5be53?raw)