VTEX Headless CMS
The VTEX Headless CMS is a solution for storefront content management.
You can use the Headless CMS API to fetch data about your project's pages and content types, including status, id, and type.
Index
Pages
Servers
https://{accountName}.myvtex.com/https://{workspace}--{accountName}.myvtex.com/
Common parameters
| Parameter name | Description | Type |
|---|---|---|
| {{accountName}} | Name of the VTEX account. Used as part of the URL. | Server variable. |
| {{workspace}} | Name of the VTEX workspace. | Server variable. |
| {{projectId}} | Project ID specified in the settings of the CMS (alpha) app. | Path variable. |
Endpoints
Pages
| Summary | Method | Path |
|---|---|---|
| Get all content types | GET | /_v/cms/api/{projectId} |
| Get all CMS pages by content type | GET | /_v/cms/api/{projectId}/{content-type} |
| Get CMS page | GET | /_v/cms/api/{projectId}/{content-type}/{document-id} |