Sign in

v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142013116.2 KB
Schemas

Get schema by name

Returns an existing schema for a given data entity.

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}/schemas/{schemaName}

Path parameters

dataEntityNamestring required
Example:Newsletter

Name of the data entity.

schemaNamestring required
Example:{{schema}}

Name of the schema.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Response

OK

v-indexedstring[]

Names of properties to index for /search, /scroll, and _sort. Required for reliable filtering (e.g. _where=field=value) and sorting (_sort=field ASC). Indexing is asynchronous after schema save.