snowdog/module-cms-api

Custom CMS API endpoints which retrieves CMS pages and blocks filtered

Maintainers

Package info

github.com/SnowdogApps/magento2-cms-api

Type:magento2-module

pkg:composer/snowdog/module-cms-api

Statistics

Installs: 68 966

Dependents: 0

Suggesters: 0

Stars: 33

Open Issues: 2

1.11.0 2023-11-06 09:55 UTC

This package is auto-updated.

Last update: 2026-03-06 15:18:00 UTC


README

The module provides endpoints to get CMS blocks and pages filtered.

1. Installation:

  • composer require snowdog/module-cms-api
  • bin/magento module:enable Snowdog_CmsApi
  • bin/magento setup:upgrade

2. Available endpoints:

  • /rest/V1/snowdog/cmsPage/:pageId: retrieves page info by its id (integer value)
  • /rest/V1/snowdog/cmsPage/search: retrieves the list of pages (accepts search criteria filters)
  • /rest/V1/snowdog/cmsPageIdentifier/:identifier/storeId/:storeId: retrieves page info by its identifier (string value) and store id (integer value)
  • /rest/V1/snowdog/cmsBlock/:blockId: retrieves block info by its id (integer value)
  • /rest/V1/snowdog/cmsBlockIdentifier/:identifier/storeId/:storeId: retrieves block info by its identifier (string value) and store id (integer value)
  • /rest/V1/snowdog/cmsBlock/search: retrieves the list of blocks (accepts search criteria filters)

License

MIT