PHPackages                             johannschopplich/kirby-headless - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. johannschopplich/kirby-headless

ActiveKirby-plugin[API Development](/categories/api)

johannschopplich/kirby-headless
===============================

API-first toolkit for Kirby CMS

6.0.1(3mo ago)4414.1k—6.7%6MITPHP

Since Dec 28Pushed 2mo ago3 watchersCompare

[ Source](https://github.com/johannschopplich/kirby-headless)[ Packagist](https://packagist.org/packages/johannschopplich/kirby-headless)[ Docs](https://kirby.tools/docs/headless)[ Fund](https://paypal.me/jschopplich)[ RSS](/packages/johannschopplich-kirby-headless/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (76)Used By (0)

[![Kirby Headless Preview](./.github/kirby-headless.png)](./.github/kirby-headless.png)

Kirby Headless
==============

[](#kirby-headless)

This plugin is designed for developers who want to use Kirby's backend to serve content to a frontend application, static site generator, or mobile application. You can either add headless functionality to your existing Kirby site, or use this plugin to build a headless-first CMS from scratch.

Note

Check out to the [Kirby Headless Starter](https://github.com/johannschopplich/kirby-headless-starter) repository for a ready-to-use headless-only setup!

Key Features
------------

[](#key-features)

- 🧩 Optional bearer token authentication for [KQL](https://kirby.tools/docs/headless/usage/kql) and custom API endpoints
- 🧱 Resolve fields in blocks: [UUIDs to file and page objects](https://kirby.tools/docs/headless/usage/field-methods) or [any other field](https://kirby.tools/docs/headless/usage/field-methods)
- ⚡️ Cached KQL queries
- 🌐 Multi-language support for KQL queries
- 🍢 Express-esque [API builder](https://kirby.tools/docs/headless/advanced/api-builder) with middleware support
- 🗂 Return [JSON from templates](https://kirby.tools/docs/headless/usage/json-templates) instead of HTML

Compatibility
=============

[](#compatibility)

The current version of Kirby Headless is compatible with Kirby 4 and 5.

Installation
------------

[](#installation)

Tip

[📖 Read the documentation](https://kirby.tools/docs/headless/getting-started/installation)

### Composer

[](#composer)

The recommended way to install the plugin is via Composer. To install the plugin, run the following command in your terminal:

```
composer require johannschopplich/kirby-headless
```

### Download

[](#download)

Head over to the [releases page](https://github.com/johannschopplich/kirby-headless/releases) and download the latest version of the plugin as a ZIP file. Extract the contents of this ZIP file to your `site/plugins` folder. It should look like this:

```
site/plugins/
├─ kirby-headless/
│  └─ … Plugin files

```

Usage
-----

[](#usage)

Tip

[📖 Read the documentation](https://kirby.tools/docs/headless/usage/kql)

License
-------

[](#license)

[MIT](./LICENSE) License © 2022-PRESENT [Johann Schopplich](https://github.com/johannschopplich)

###  Health Score

52

—

FairBetter than 96% of packages

Maintenance82

Actively maintained with recent releases

Popularity38

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 99% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~15 days

Recently: every ~59 days

Total

74

Last Release

117d ago

Major Versions

1.7.1 → 2.0.02023-09-28

2.3.7 → 3.0.02024-02-12

3.3.0 → 4.0.02024-08-08

4.0.2 → 5.0.02025-05-27

5.0.3 → 6.0.02025-12-08

### Community

Maintainers

![](https://www.gravatar.com/avatar/b9be5bf8dd3a36f63c00f92a115f1109567745fb3b068617341ffc8a90755d6c?d=identicon)[johannschopplich](/maintainers/johannschopplich)

---

Top Contributors

[![johannschopplich](https://avatars.githubusercontent.com/u/27850750?v=4)](https://github.com/johannschopplich "johannschopplich (208 commits)")[![AlexHupe](https://avatars.githubusercontent.com/u/6893843?v=4)](https://github.com/AlexHupe "AlexHupe (1 commits)")[![bnomei](https://avatars.githubusercontent.com/u/3265642?v=4)](https://github.com/bnomei "bnomei (1 commits)")

---

Tags

headlesskirby-cmskirby-pluginkirby-themekirby4kirby5headlesskirby

### Embed Badge

![Health badge](/badges/johannschopplich-kirby-headless/health.svg)

```
[![Health](https://phpackages.com/badges/johannschopplich-kirby-headless/health.svg)](https://phpackages.com/packages/johannschopplich-kirby-headless)
```

###  Alternatives

[getkirby/kql

Kirby Query Language

15124.3k](/packages/getkirby-kql)[jcalderonzumba/gastonjs

PhantomJS API based server for webpage automation

13111.1M72](/packages/jcalderonzumba-gastonjs)[kontent-ai/delivery-sdk-php

Kontent.ai Delivery SDK for PHP

4628.8k](/packages/kontent-ai-delivery-sdk-php)[luyadev/luya-headless

LUYA headless API client

1025.6k3](/packages/luyadev-luya-headless)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
