Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

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.

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

SummaryMethodPath
Get all content typesGET/_v/cms/api/{projectId}
Get all CMS pages by content typeGET/_v/cms/api/{projectId}/{content-type}
Get CMS pageGET/_v/cms/api/{projectId}/{content-type}/{document-id}

Loading API specification...