vtex.local – Headless-CMS-API

OpenAPI apis-guru

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/
https://{workspace}--{account}.myvtex.com/

Server variables

accountName: Name of your VTEX account.
workspace: Name of your VTEX workspace.

Homepage: https://api.apis.guru/v2/specs/vtex.local:Headless-CMS-API/0.31.2.json
Provider: vtex.local:Headless-CMS-API / Headless-CMS-API
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/vtex.local/Headless-CMS-API/0.31.2/openapi.yaml

Tools (5)

Extracted live via the executor SDK.

pages.getAllContentTypes

Gets data from all Content Types.
pages.getCmSpage

Gets all data from a given page.
pages.getPagesbyContentType

Gets data from all pages of a given Content Type.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools