lindemannrock/craft-formie-rest-api

REST API for Formie - Provides REST endpoints for accessing Formie forms and submissions

Maintainers

Package info

github.com/LindemannRock/craft-formie-rest-api

Documentation

Type:craft-plugin

pkg:composer/lindemannrock/craft-formie-rest-api

Statistics

Installs: 116

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

3.10.1 2026-06-18 11:01 UTC

Requires

Requires (Dev)

proprietary b0bb850dfdb5ea967f4d0e676928c4b62805e0c2

apicmsREST APICraftcraftcmscraft-pluginformie

This package is auto-updated.

Last update: 2026-06-20 12:20:25 UTC

README

Formie REST API

Formie REST API Plugin

Latest Version Craft CMS Formie PHP License

A REST API plugin for Craft CMS that exposes Formie forms and submissions through authenticated REST endpoints. Designed for external systems (e.g. SAP, BI tools, partner integrations) that need structured form data over HTTP.

Note on GraphQL: Formie ships with its own GraphQL schema at Craft's /api endpoint. This plugin does not add GraphQL — it adds a separate REST API with its own auth (X-API-Key), rate limiting, and access logging. If you want GraphQL, use Formie's built-in support directly.

License

This is a commercial plugin licensed under the Craft License. It will be available on the Craft Plugin Store soon. See LICENSE.md for details.

⚠️ Pre-Release

This plugin is in active development and not yet available on the Craft Plugin Store. Features and APIs may change before the initial public release.

Features

  • REST endpoints — list and read Formie forms and submissions as JSON
  • CP-managed API keys — one key per consumer, with per-key form scoping, submissions toggle, expiry, and an enable switch
  • API-key authentication — via the X-API-Key header
  • HMAC request signing — optional per key (replay + tamper protection)
  • IP whitelist — optional per key (IPv4/IPv6 + CIDR)
  • Rate limiting — per-key hourly budget with X-RateLimit-* headers and 429 on exceed
  • Access logging — every request logged via the Logging Library
  • In-CP test page — try endpoints and download a Postman collection without leaving Craft
  • Translated CP UI — 12 languages

Requirements

  • Craft CMS 5.0 or greater
  • PHP 8.2 or greater
  • Formie 3.0 or greater

Installation

Via Composer

composer require lindemannrock/craft-formie-rest-api
php craft plugin/install formie-rest-api

Using DDEV

ddev composer require lindemannrock/craft-formie-rest-api
ddev craft plugin/install formie-rest-api

Documentation

Full documentation is available in the docs folder.

Support

License

This plugin is licensed under the Craft License. See LICENSE.md for details.

Developed by LindemannRock

Built for use with Formie by Verbb