VTvtex
Documents

Get document

Changed on

Retrieves a document by ID.

ℹ️ Assign the _fields parameter in the query string to retrieve the desired fields. If you want to return all the fields use _fields=_all.

ℹ️ Fields configured as personal data are returned with masked values by default. To retrieve the original values, add the _unmasked=true query parameter.

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

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/dataentities/{dataEntityName}/documents/{id}
  • 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.

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

ID of the Document.

Query parameters

_fieldsstring
Example:email,firstName,document

Fields that should be returned by document. Separate fields' names with commas. For example _fields=email,firstName,document. You can also use _fields=_all to fetch all fields.

_schemastring
Example:schema

Name of the schema that the document complies with. This field is required when using _where or _fields query parameters.

_unmaskedboolean

When set to true, fields configured as personal data are returned with their original values instead of masked. Only takes effect if the data entity has personal data configured via Configure personal data fields; otherwise it is ignored. By default (false), personal data fields are returned with masked values (e.g., j***@****.com).

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

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

Response

OK

idstring required

ID of the document.

accountIdstring required

ID of the VTEX account.

accountNamestring required

Name of the VTEX account.

dataEntityIdstring required

Data entity name.

Changes