VTEX Headless CMS

vtex · Company

Company No Auth Free & Open API

The VTEX Headless CMS is a no-code management system for storefront content. That means you can store your content as structured data in a layer decoupled from the frontend and use the VTEX Headless CMS to access and deliver your content to your storefront project. Notice that the VTEX Headless CMS typically works with **FastStore** projects only. In this case, you can use this API to fetch data using SSR (NextJS and Gatsby v4+) or SSG (NextJS). **Servers** - `https://{account}.myvtex.com/`

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get all Content Types

Gets data from all Content Types.

https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/';

const response = await fetch(url); 
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/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/"
	req, _ := http.NewRequest("GET", targetURL, nil)

	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/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/")

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

req = Net::HTTP::Get.new(uri)

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

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get all CMS pages by Content Type

Gets data from all pages of a given Content Type.

https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}?releaseId=6196c277c6dce15f9709a2a7&versionId=e7263fc8-bc68-4052-9e25-dd5a2572d3bb&filters[{field}]=published

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}?releaseId=6196c277c6dce15f9709a2a7&versionId=e7263fc8-bc68-4052-9e25-dd5a2572d3bb&filters[{field}]=published"

import requests
params = {
    "releaseId": "6196c277c6dce15f9709a2a7",
    "versionId": "e7263fc8-bc68-4052-9e25-dd5a2572d3bb",
    "filters[{field}]": "published"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}');
url.searchParams.set('releaseId', '6196c277c6dce15f9709a2a7');
url.searchParams.set('versionId', 'e7263fc8-bc68-4052-9e25-dd5a2572d3bb');
url.searchParams.set('filters[{field}]', 'published');

const response = await fetch(url); 
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/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}")
	q := baseURL.Query()
	q.Set("releaseId", "6196c277c6dce15f9709a2a7")
	q.Set("versionId", "e7263fc8-bc68-4052-9e25-dd5a2572d3bb")
	q.Set("filters[{field}]", "published")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	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/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}")
uri.query = URI.encode_www_form({
  "releaseId" => "6196c277c6dce15f9709a2a7",
  "versionId" => "e7263fc8-bc68-4052-9e25-dd5a2572d3bb",
  "filters[{field}]" => "published"
})

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

req = Net::HTTP::Get.new(uri)

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

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}?" . http_build_query([
    "releaseId" => "6196c277c6dce15f9709a2a7",
    "versionId" => "e7263fc8-bc68-4052-9e25-dd5a2572d3bb",
    "filters[{field}]" => "published"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get CMS page

Gets all data from a given page.

https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}?releaseId=6196c277c6dce15f9709a2a7&versionId=e7263fc8-bc68-4052-9e25-dd5a2572d3bb

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}/?releaseId=6196c277c6dce15f9709a2a7&versionId=e7263fc8-bc68-4052-9e25-dd5a2572d3bb"

import requests
params = {
    "releaseId": "6196c277c6dce15f9709a2a7",
    "versionId": "e7263fc8-bc68-4052-9e25-dd5a2572d3bb"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}/",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}/');
url.searchParams.set('releaseId', '6196c277c6dce15f9709a2a7');
url.searchParams.set('versionId', 'e7263fc8-bc68-4052-9e25-dd5a2572d3bb');

const response = await fetch(url); 
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/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}/")
	q := baseURL.Query()
	q.Set("releaseId", "6196c277c6dce15f9709a2a7")
	q.Set("versionId", "e7263fc8-bc68-4052-9e25-dd5a2572d3bb")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	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/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}/")
uri.query = URI.encode_www_form({
  "releaseId" => "6196c277c6dce15f9709a2a7",
  "versionId" => "e7263fc8-bc68-4052-9e25-dd5a2572d3bb"
})

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

req = Net::HTTP::Get.new(uri)

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

<?php
$url = "https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/_v/cms/api/{builderId}/{content-type}/{document-id}/?" . http_build_query([
    "releaseId" => "6196c277c6dce15f9709a2a7",
    "versionId" => "e7263fc8-bc68-4052-9e25-dd5a2572d3bb"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$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 VTEX Headless CMS?

VTEX Headless CMS 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. VTEX Headless CMS is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗