Skip to main content
Version: 1.0

APIs Overview

This is the cross-framework API index. Each framework maintains its own complete API reference inline in its own section (request/response examples, permissions, headers, error codes) — this page is a hub that points to them, plus the future home of generated OpenAPI documentation.

Published API references

FrameworkAPI reference
Notification Framework9. API Documentation — 120 documented HTTP actions across 12 active controllers + the legacy MultiTenancyApi stack

OpenAPI (prepared, not yet generated)

This portal's structure is prepared to host generated OpenAPI reference pages (e.g. via an OpenAPI-docs plugin rendering a live, interactive spec browser) alongside the hand-written API chapters above. No OpenAPI specification is generated today — when a framework publishes a machine-readable OpenAPI/Swagger document, it will be wired into this section without disturbing the existing hand-written reference pages.

Adding a new framework's API reference

When a new framework's documentation is published through this portal, add a row to the table above pointing to that framework's own API reference chapter — do not duplicate endpoint documentation here.