VTvtex
Personal data

Get personal data configuration

Changed on

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 must have at least one of the appropriate License Manager resources 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:

ProductCategoryResource
Dynamic StorageDynamic storage generic resourcesRead only documents
Dynamic StorageDynamic storage generic resourcesInsert or update document (not remove)
Dynamic StorageDynamic storage generic resourcesFull access to all documents
Dynamic StorageDynamic storage generic resourcesMaster Data administrator

There are no applicable predefined roles for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

get/api/dataentities/{dataEntityName}/personalData

Request

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

Path parameters

dataEntityNamestring required
Example:Newsletter

Name of the data entity.

Headers

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Fieldsstring[] 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.

SubjectIdFieldstring 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.

Changes