canonical: https://jentic.com/apis/vtex.local/master-data-api---v1

# Vtex Master Data API - v1

Master Data is a highly customizable VTEX database solution, which enables you to create applications. By default, Master Data is used to store and organize Customer data from your store. It features a powerful search engine, allowing you to store, search, expand, and customize data. Learn more about [Master Data v1](https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw). Index Dat. The API exposes 25 endpoints secured with apiKey authentication.

## For AI agents

Programmatically list data entities, get data entity structure. Covers 25 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- List data entities
- Get data entity structure
- Create new document
- Update partial document
- Monitor Master Data API - v1 operational status and events

## Use cases

### E-Commerce Operations

Use the Master Data API - v1 to perform e commerce operations programmatically. The API provides 25 endpoints covering core functionality including list data entities, get data entity structure, create new document.

Example prompt: Call GET `/api/dataentities` to list data entities

### Automated Data Entities Management

Automate data entities operations by combining multiple Master Data API - v1 endpoints. Agents can get data entity structure and then create new document in a single workflow.

Example prompt: Call GET `/api/dataentities/{acronym}` to get data entity structure, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Master Data API - v1 endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'list data entities', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/dataentities` | List data entities |
| GET | `/api/dataentities/{acronym}` | Get data entity structure |
| POST | `/api/dataentities/{acronym}/documents` | Create new document |
| PATCH | `/api/dataentities/{acronym}/documents` | Create partial document |
| GET | `/api/dataentities/{acronym}/documents/{id}` | Get document |
| PUT | `/api/dataentities/{acronym}/documents/{id}` | Create document with custom ID or update entire document |
| PATCH | `/api/dataentities/{acronym}/documents/{id}` | Update partial document |
| DELETE | `/api/dataentities/{acronym}/documents/{id}` | Delete document |

## Key resources

- **Data Entities** — Operations related to Data Entities
- **Documents** — Operations related to Documents
- **Customer profiles** — Operations related to Customer profiles
- **Addresses** — Operations related to Addresses
- **Versions** — Operations related to Versions

## Why Jentic

- **Setup:** Wiring the VTEX Master Data API v1 by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and templating the {accountName} and {environment} host into every call. Through Jentic you install once, import the Master Data API v1 from the API Directory, store the App Key and App Token once, and your agent calls it.
- **Permission scoping:** The Master Data API v1 puts the data entity acronym and document id in the URL path (`/api/dataentities/{acronym}/documents/{id}`), so a rule can pin your agent to one data entity and its documents. You choose the operations it may call, so destructive ones like deleting a document are not included unless you add them.
- **Credential handling:** Your VTEX App Key and App Token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list data entities' or 'create a document in a data entity', and Jentic returns the matching Master Data API v1 operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Master Data API - v1 use?

The Master Data API - v1 uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I list data entities with the Master Data API - v1?

Yes. Use the GET `/api/dataentities` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Master Data API - v1?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I list data entities through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list data entities'. Jentic returns the matching Master Data API - v1 operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Master Data API - v1 have?

The Master Data API - v1 exposes 25 endpoints covering data entities, documents, customer profiles operations.

### Can I limit what my agent is allowed to do with the VTEX Master Data API?

Yes. Jentic One is self-hosted by you, so your own rules decide which Master Data API operations and stored credentials the agent may use. Because the API puts the data entity acronym and document id in the URL path (`/api/dataentities/{acronym}/documents/{id}`), you can pin the agent to a single data entity and its documents. You also choose the operations it may call, so destructive ones like DELETE `/api/dataentities/{acronym}/documents/{id}` stay out of reach unless you add them.