---
title: API Dokumentation
description: "Die RESTful API wird mit dem [OpenAPI Standard](https://swagger.io/specification/) (ehemals Swagger) dokumentiert. Jedes ChurchTools wird mit der Dokumentation ausgeliefert und kann über einen Link wie `https://meine-gemeinde.church.tools/api` aufgerufen werden.   **Hinweis** `meine-gemeinde` muss hierbei ersetzt werden mit dem Namen der eigenen Installation.…"
url: "https://staging.churchtools.academy/de/help/system-einstellungen/api/api-dokumentation/"
updated: "2026-08-24"
category: Integrationen / API
tags:
  - Inhalt veraltet
---

# API Dokumentation

Die RESTful API wird mit dem [OpenAPI Standard](https://swagger.io/specification/) (ehemals Swagger) dokumentiert. Jedes ChurchTools wird mit der Dokumentation ausgeliefert und kann über einen Link wie `https://meine-gemeinde.church.tools/api` aufgerufen werden.  

**Hinweis**

`meine-gemeinde` muss hierbei ersetzt werden mit dem Namen der eigenen Installation.

Die Dokumenation ist mit der Swagger-UI in ChurchTools integriert. Das bietet folgende Vorteile:  

1. Einfacher Überblick über alle verfügbaren Endpoints
2. Testen: Die UI erlaubt es, direkt im Browser Requests abzufeuern und so die API zu testen
3. ChurchTools-User: Ist man in ChurchTools eingeloggt, werden alle Requests über die UI direkt mit dem eigenen Benutzer gesendet. So kann man die API schnell und einfach testen.  

**Achtung**

Sollte der eigene Benutzer viele Berechtigungen besitzen, können über die API auch Dinge geändert oder gelöscht werden.

[![ChurchTools REST API](https://staging.churchtools.academy/wp-content/uploads/2024/03/CTCstable_ChurchTools-REST-API.png)](https://staging.churchtools.academy/wp-content/uploads/2024/03/CTCstable_ChurchTools-REST-API.png)

## API-Spezifikation als JSON-Datei

Durch den Standard ist es möglich, die ganze Dokumentation als JSON-Datei für eigene Projekte heranzuziehen. Die ganze Spezifikation ist über den Link `https://meine-gemeinde.church.tools/system/runtime/swagger/openapi.json` erreichbar.

## Artikel zum Weiterlesen

- [Überblick API](https://staging.churchtools.academy/de/help/system-einstellungen/api/uberblick-api/)
- [API Authentifizierung](https://staging.churchtools.academy/de/help/system-einstellungen/api/api-authentifizierung/)