README

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 fetching 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.

Supported Platforms

• @query-api/js: Core SDK for all JavaScript Frameworks.
• @query-api/vue: SDK for Vue.
• @query-api/nuxt: SDK for Nuxt.
• @query-api/react: SDK for React.
• @query-api/next: SDK for Next.

Support

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