{"id":35632,"date":"2024-02-14T17:22:11","date_gmt":"2024-02-14T16:22:11","guid":{"rendered":"https:\/\/churchtools.academy\/help\/non-knowledgebase\/uncategorized\/overview-api\/"},"modified":"2025-11-17T11:43:03","modified_gmt":"2025-11-17T10:43:03","password":"","slug":"overview-api","status":"publish","type":"docs","link":"https:\/\/churchtools.academy\/en\/help\/system-settings\/api\/overview-api\/","title":{"rendered":"Overview API"},"content":{"rendered":"\n<p>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. <\/p>\n\n\n\n<p>There is an old API based on function calls and a new REST API.<\/p>\n\n\n\n<figure class=\"wp-block-embed is-type-video is-provider-youtube wp-block-embed-youtube wp-embed-aspect-16-9 wp-has-aspect-ratio\"><div class=\"wp-block-embed__wrapper\">\n<iframe title=\"ChurchTools API - \u00dcberblick\" width=\"800\" height=\"450\" src=\"https:\/\/www.youtube.com\/embed\/a2dWZTOnGFM?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" allowfullscreen><\/iframe>\n<\/div><figcaption class=\"wp-element-caption\">This video is currently only available in German.<\/figcaption><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">RESTful API<\/h2>\n\n\n\n<p>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&#8217; 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 <strong>first<\/strong>: <a href=\"https:\/\/forum.church.tools\/topic\/5121\/restful-api-vorstellung\">RESTful API: Introduction<\/a>.<br>Unfortunately, all links to the forum are only in German.   <\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Further links<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/forum.church.tools\/topic\/5121\/restful-api-vorstellung\">https:\/\/forum.church.tools\/topic\/5121\/restful-api-vorstellung<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/github.com\/churchtools\/churchtools-js-client\">https:\/\/github.com\/churchtools\/churchtools-js-client<\/a><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\">AJAX API<\/h2>\n\n\n\n<p>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.  <\/p>\n\n\n\n<p>Dokumentation zur Nutzung gibt es <a href=\"https:\/\/churchtools.academy\/de\/help\/system-settings\/api\/0-api-alt\/\" data-type=\"docs\" data-id=\"7254\">hier<\/a>.<\/p>\n\n\n\n<p><strong>Inquiries about the AJAX API are not covered by our support.<\/strong> If you have any questions, please refer to the <a href=\"https:\/\/forum.church.tools\/category\/22\/churchtools-schnittstellen\">forum<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>API CSRF<\/strong><\/h2>\n\n\n\n<p>Sicherheit: <a href=\"https:\/\/churchtools.academy\/en\/help\/system-settings\/general-data-security-privacy\/csrf-prevention\/\" type=\"docs\" id=\"7638\">CSRF Token<\/a> mitschicken<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Further links<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/github.com\/churchtools\/churchtools-js-client\">https:\/\/github.com\/churchtools\/churchtools-js-client<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/github.com\/5pm-HDH\/churchtools-api\">https:\/\/github.com\/5pm-HDH\/churchtools-api<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/github.com\/fodinabor\/CT-API-Tools\">https:\/\/github.com\/fodinabor\/CT-API-Tools<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/forum.church.tools\/topic\/4489\/frage-zur-benutzung-der-api\">https:\/\/forum.church.tools\/topic\/4489\/frage-zur-benutzung-der-api<\/a><\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>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 [&hellip;]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"doc_category":[461,461],"doc_tag":[653],"knowledge_base":[425],"class_list":{"0":"post-35632","1":"docs","2":"type-docs","3":"status-publish","4":"hentry","5":"doc_category-api-en","7":"doc_tag-content-outdated-en","8":"knowledge_base-system-settings"},"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","acf":[],"year_month":"2026-04","word_count":228,"total_views":"2341","reactions":{"happy":"0","normal":"0","sad":"1"},"author_info":{"name":"Victoria Weidemann","author_nicename":"vweidemann","author_url":"https:\/\/churchtools.academy\/en\/author\/vweidemann\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/churchtools.academy\/en\/help\/system-settings\/api-en\/"},{"term_name":"API","term_url":"https:\/\/churchtools.academy\/en\/help\/system-settings\/api-en\/"}],"doc_tag_info":[{"term_name":"Content outdated","term_url":"https:\/\/churchtools.academy\/en\/docs-tag\/content-outdated-en\/"}],"knowledge_base_info":[{"term_name":"System Settings","term_url":"https:\/\/churchtools.academy\/en\/help\/system-settings\/","term_slug":"system-settings"}],"knowledge_base_slug":["system-settings"],"_links":{"self":[{"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/35632","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/comments?post=35632"}],"version-history":[{"count":9,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/35632\/revisions"}],"predecessor-version":[{"id":42317,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/35632\/revisions\/42317"}],"wp:attachment":[{"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/media?parent=35632"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/doc_category?post=35632"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/doc_tag?post=35632"},{"taxonomy":"knowledge_base","embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/knowledge_base?post=35632"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}