---
title: API documentation
description: "The RESTful API is documented using the [OpenAPI standard](https://swagger.io/specification/) (formerly Swagger). Each ChurchTools is delivered with the documentation and can be accessed via a link such as `https://meine-gemeinde.church.tools/api`. **Note** `meine-gemeinde` must be replaced with the name of your own installation.…"
url: "https://staging.churchtools.academy/en/help/system-settings/api-en/api-documentation/"
updated: "2026-07-29"
category: Integrations / API
tags:
  - Content outdated
---

# API documentation

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

**Note**

`meine-gemeinde` must be replaced with the name of your own installation.

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.

**Warning**

If the user has a lot of permissions, things can also be changed or deleted via the API.

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

## 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`.

## Read more

- [Overview API](https://staging.churchtools.academy/en/help/system-settings/api-en/overview-api/)
- [API authentication](https://staging.churchtools.academy/en/help/system-settings/api-en/api-authentication/)