Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142616180.5 KB
Data entities

List data entities

Retrieves the list of existing data entities in the store.

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 resourcesMaster Data administrator
Dynamic StorageData entityList data entity

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

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

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

Response

OK

acronymstring required

Two-letter string that identifies the data entity.

namestring required

Data entity name.

primaryKeyTypestring required

Primary key type.

allowGetAllboolean required

Defines if it will be allowed to retrieve all fields from documents from this data entity at once using the Get document endpoint (true) or not (false).

All 26 operations