API documentation

< 1 Min. lesen

Table of Contents

The RESTful API is documented using the OpenAPI standard (formerly Swagger). Each ChurchTools is delivered with the documentation and can be accessed via a link such as
https://meine-gemeinde.church.tools/api.

The documentation is integrated with the Swagger UI in ChurchTools. This offers the following advantages:

  1. Simple overview of all available endpoints
  2. Testing: The UI allows requests to be fired directly in the browser to test the API
  3. ChurchTools user: If you are logged in to ChurchTools, all requests are sent directly to your own user via the UI. This allows you to test the API quickly and easily.
ChurchTools REST API

API specification as JSON file #

The standard makes it possible to use the entire documentation as a JSON file for your own projects. The entire specification can be accessed via the link https://meine-gemeinde.church.tools/system/runtime/swagger/openapi.json.

Aktualisiert am 28. January 2026
Was this page helpful for you?
  • Content outdated
Table of Contents