Get Started

Introduction

Use the Craft CMS query builder, enabling efficient data fetching.

The Query API extends your Craft CMS project with endpoints, allowing you to query Addresses, Assets, Entries, and Users using simple URL parameters.

The plugin speeds up and simplifies headless development with Craft CMS, so you as a developer can focus on the important parts of your application.

Frontend SDKs

It’s designed to make headless development incredibly fast and flexible, especially when paired with our SDKs. These libraries let you build queries in JavaScript using a query builder that feels just like Craft’s native Twig syntax.

Vue SDK: A package to use the query builder in Vue.
Nuxt SDK: A package to use the query builder in Nuxt.
React SDK: A package to use the query builder in React.
Next SDK: A package to use the query builder in Next.js.
JS SDK: Foundation to build a query builder with your preferred JS framework.

Requirements

Requires Craft CMS 5.0.0 or later.
PHP 8.2 or later.
For optimal image performance, it's highly recommended to use ImagerX.

Supported Element Types

Addresses
Assets
Entries
Users

Note

To access any API endpoint, you must include a valid access token. This enforces secure, scoped access to your Craft CMS data.

Need Help?

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

Craft Query API

A plugin for using the Craft CMS query builder externally.

Installation

Learn how to install the Craft Query API Craft CMS plugin.

Usefull Links