v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-142616180.5 KB
Versions

Get version

Returns the version of a document.

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/{acronym}/documents/{id}/versions/{versionId}

Path parameters

acronymstring required
Example:SP

Two-letter string that identifies the data entity.

idstring required
Example:SP-b818cbda-e489-11e6-94f4-0ac138d2d42e

Unique identifier of the document.

versionIdstring required
Example:_X58kLameckHYRuBMUbaimlhwqslsrrwT_

Unique identifier of the version to retrieve.

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

idstring required

Unique identifier of the version.

authorstring required

Unique identifier of the user who created the version.