johannschopplich / kirby-headless
KQL, JSON templates, and API routes for Kirby CMS
Package info
github.com/johannschopplich/kirby-headless
Type:kirby-plugin
pkg:composer/johannschopplich/kirby-headless
Fund package maintenance!
Requires
- php: >=8.2
- getkirby/composer-installer: ^1
Requires (Dev)
- getkirby/cms: ^5
- getkirby/kql: ^3
- phpunit/phpunit: ^12
Suggests
None
Provides
None
Conflicts
None
Replaces
None
- dev-main
- 8.1.0
- 8.0.0
- 7.0.0
- 6.0.2
- 6.0.1
- 6.0.0
- 5.0.3
- 5.0.2
- 5.0.1
- 5.0.0
- 4.0.2
- 4.0.1
- 4.0.0
- 3.3.0
- 3.2.1
- 3.2.0
- 3.1.6
- 3.1.5
- 3.1.4
- 3.1.3
- 3.1.2
- 3.1.1
- 3.1.0
- 3.0.4
- 3.0.3
- 3.0.2
- 3.0.1
- 3.0.0
- 2.3.7
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.5
- 2.2.4
- 2.2.3
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.1
- 2.1.0
- 2.0.0
- 1.7.1
- 1.7.0
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.8
- 1.5.7
- 1.5.6
- 1.5.5
- 1.5.4
- 1.5.3
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.5
- 1.4.4
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.3
- 1.3.2
- 1.3.1
- 1.3.0
- 1.2.1
- 1.2.0
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.2
- 1.0.1
- 1.0.0
- dev-feat/v4-compat
This package is auto-updated.
Last update: 2026-09-14 15:55:17 UTC
README
Kirby Headless
Kirby Headless is a plugin for Kirby CMS: JSON pages and KQL queries, served behind one bearer token.
Authentication • KQL • Field Methods • Page Methods
Note
Want a ready-to-use headless-only project? Start from the Kirby Headless Starter.
When to Use
| I want to… | Use |
|---|---|
| Query content from a frontend over HTTP | KQL endpoint at /api/kql |
| Lock the API behind a token instead of basic auth | kql.auth => 'bearer' + headless.token |
| Resolve UUIDs in blocks and layouts to real objects | $field->toResolvedBlocks() |
| Return JSON straight from a template | JSON templates / __template__ endpoint |
| Compose custom, authenticated API routes | Api::createHandler() + middlewares |
Requirements
- Kirby 5
Note
Using Kirby 4? Install the v4 release.
Installation
Composer (Recommended)
composer require johannschopplich/kirby-headless
Manual Installation
Download and copy this repository to /site/plugins/kirby-headless.
Documentation
For installation, configuration, and usage, see the Kirby Headless documentation.
License
MIT License © 2022-PRESENT Johann Schopplich