All functions that are available in ChurchTools can also be used via the API. The ChurchTools front end and the app work in exactly the same way.
There is an old API based on function calls and a new REST API.
RESTful API #
ChurchTools has a REST API that can be used to retrieve information but also for actions. Many endpoints have already been implemented, but not all of ChurchTools’ functionality has yet been realized. The API is improved and expanded with each version. For background information and suggestions, we recommend reading this forum post first: RESTful API: Introduction.
Further links #
- https://forum.church.tools/topic/5121/restful-api-vorstellung
- https://github.com/churchtools/churchtools-js-client
AJAX API #
ChurchTools has an AJAX API. This is still used in many places, but is gradually being replaced by the REST API. Most functions can be addressed with it, creating interesting application possibilities.
Documentation on use is available here.
Inquiries about the AJAX API are not covered by our support. If you have any questions, please refer to the forum.
API CSRF #
Security: Send CSRF token along