MasterData API - v1

vtex · Company

Company No Auth Free & Open API

MasterData API - v1 API

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET List data entities

Retrieves the list of existing data entities in the store. ### Response status code 1. Status Code `403`: Access not allowed 2. Status Code `200`: Retrieves data entity list > All headers listed below are required.

https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/vnd.vtex.ds.v10+json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities" \
  -H "Accept: application/vnd.vtex.ds.v10+json" \
  -H "Content-Type: application/json"

import requests
headers = {
    "Accept": "application/vnd.vtex.ds.v10+json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/vnd.vtex.ds.v10+json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/vnd.vtex.ds.v10+json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/vnd.vtex.ds.v10+json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/vnd.vtex.ds.v10+json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Search documents

Search documents by the query parameters described below. > Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with

https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search?_sort=firstName ASC&_where=firstName is not null&_fields=email,firstName,document&_schema={{schema}}&_keyword=String to search

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/vnd.vtex.ds.v10+json
REST-Range	resources=0-10
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search?_sort=firstName%20ASC&_where=firstName%20is%20not%20null&_fields=email%2CfirstName%2Cdocument&_schema=%7B%7Bschema%7D%7D&_keyword=String%20to%20search" \
  -H "Accept: application/vnd.vtex.ds.v10+json" \
  -H "REST-Range: resources=0-10" \
  -H "Content-Type: application/json"

import requests
params = {
    "_sort": "firstName ASC",
    "_where": "firstName is not null",
    "_fields": "email,firstName,document",
    "_schema": "{{schema}}",
    "_keyword": "String to search"
}
headers = {
    "Accept": "application/vnd.vtex.ds.v10+json",
    "REST-Range": "resources=0-10",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search');
url.searchParams.set('_sort', 'firstName ASC');
url.searchParams.set('_where', 'firstName is not null');
url.searchParams.set('_fields', 'email,firstName,document');
url.searchParams.set('_schema', '{{schema}}');
url.searchParams.set('_keyword', 'String to search');

const response = await fetch(url, {
  headers: {
    'Accept': 'application/vnd.vtex.ds.v10+json',
    'REST-Range': 'resources=0-10',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search")
	q := baseURL.Query()
	q.Set("_sort", "firstName ASC")
	q.Set("_where", "firstName is not null")
	q.Set("_fields", "email,firstName,document")
	q.Set("_schema", "{{schema}}")
	q.Set("_keyword", "String to search")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/vnd.vtex.ds.v10+json")
	req.Header.Set("REST-Range", "resources=0-10")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search")
uri.query = URI.encode_www_form({
  "_sort" => "firstName ASC",
  "_where" => "firstName is not null",
  "_fields" => "email,firstName,document",
  "_schema" => "{{schema}}",
  "_keyword" => "String to search"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/vnd.vtex.ds.v10+json"
req["REST-Range"] = "resources=0-10"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}/search?" . http_build_query([
    "_sort" => "firstName ASC",
    "_where" => "firstName is not null",
    "_fields" => "email,firstName,document",
    "_schema" => "{{schema}}",
    "_keyword" => "String to search"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/vnd.vtex.ds.v10+json",
        "REST-Range: resources=0-10",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get data entity structure

Returns the data entity structure with its respective fields and data type. ### Response status code 1. Status Code `403`: Access not allowed 2. Status Code `200`: Retrieves data entity structure > All headers listed below are required.

https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Accept	application/vnd.vtex.ds.v10+json
Content-Type	application/json

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}" \
  -H "Accept: application/vnd.vtex.ds.v10+json" \
  -H "Content-Type: application/json"

import requests
headers = {
    "Accept": "application/vnd.vtex.ds.v10+json",
    "Content-Type": "application/json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}",
    headers=headers,
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}';

const response = await fetch(url, {
  headers: {
    'Accept': 'application/vnd.vtex.ds.v10+json',
    'Content-Type': 'application/json'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Accept", "application/vnd.vtex.ds.v10+json")
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Accept"] = "application/vnd.vtex.ds.v10+json"
req["Content-Type"] = "application/json"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/MasterData-API-/1.0/api/dataentities/{acronym}";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Accept: application/vnd.vtex.ds.v10+json",
        "Content-Type: application/json"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with MasterData API - v1?

MasterData API - v1 is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. MasterData API - v1 is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗