samuelreichor/craft-query-api

Speeds up development in headless mode with an API that allows querying data using URL parameters.

Maintainers

Details

github.com/samuelreichor/craft-query-api

Source

Issues

Installs: 155

Dependents: 0

Suggesters: 0

Security: 0

Stars: 9

Watchers: 1

Forks: 0

Open Issues: 0

Type:craft-plugin

3.1.1 2025-05-17 14:59 UTC

Requires

Requires (Dev)

proprietary 46b3f21a561073166e7711ce3a408291ed4ea3d7

This package is auto-updated.

Last update: 2025-05-17 15:45:23 UTC

README

Craft Query API

The Query API for Craft CMS

Craft Query API is a Craft CMS plugin that brings the query builder in your favorite js-framework.


Features

  • API to query addresses, assets, entries and users based on url parameters.
  • API for query all urls of every active page with template for prerendering.
  • Automatic detection of ImagerX transforms.
  • Automatic detection of native and custom fields on all elementTypes.
  • Events to add your own Json Transformers and Element Types.

Requirements

This plugin requires Craft CMS 5.0.0 or later, and PHP 8.2 or later.

Documentation

Visit the Craft Query API Plugin page for all documentation, guides, pricing and developer resources.

Further Resources

  • Vue Craft CMS: A package to use the query builder in Vue.
  • Nuxt Craft CMS: A package to use the query builder in Nuxt.
  • JS Craft CMS API: This package brings the query builder of craft CMS into the js ecosystem. You can build wrappers around it to support your framework.

Support

If you encounter bugs or have feature requests, please submit an issue. Your feedback helps improve the library!