EXTENSION API

Extension API

The Extension API provides read-only access to forms and municipality data exposed by the GemeindeConnect platform.

It is designed for integrations and frontend applications that need to discover available municipalities and forms. The API is designed as a server to server api for applications to regularly pool the information to update portals.

Unlike the Core API, the Extension API does not allow state-changing operations or workflow interaction.

What the Extension API is used for

The Extension API is typically used to:

  • Retrieve a list of available municipalities

  • Retrieve the forms offered by a municipality

  • Access form metadata and form URLs for display or embedding

Common consumers of the Extension API include:

  • Frontend web applications

  • Public portals

  • Client-side integrations

  • Lightweight backend services that only require discovery data

Last updated