---
title: "Get document"
method: GET
path: "/api/dataentities/{dataEntityName}/documents/{id}"
tags: ["Documents"]
---

# Get document

`GET /api/dataentities/{dataEntityName}/documents/{id}`

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

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) 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:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-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](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Path parameters

- `dataEntityName` string, required
- `id` string, required

## Query parameters

- `_fields` string
- `_schema` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- UsingFieldsAll — Document information.
  - `id` string, required — ID of the document.
  - `accountId` string, required — ID of the VTEX account.
  - `accountName` string, required — Name of the VTEX account.
  - `dataEntityId` string, required — Data entity name.

## Changes

- **2024-04-25** `48528941f9b7` — 1 info
  - added the new optional `query` request parameter `_schema`
- **2023-10-19** `5bf3265c027c` — 1 breaking
  - for the `query` request parameter `_fields`, default value `email,firstName,document` was removed
- **2023-10-19** `21be1e438b39` — 1 info
  - added the new optional `query` request parameter `_fields`

[Change history](https://skmtc.dev/vtex/apis/master-data-api-v2/changes/api/dataentities/:dataEntityName/documents/:id/get.md)

---

[API](https://skmtc.dev/vtex/apis/master-data-api-v2.md) · [All operations](https://skmtc.dev/vtex/apis/master-data-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/master-data-api-v2/revisions/6d3f8010fa54/schema)