{"id":45041,"date":"2024-03-27T12:50:31","date_gmt":"2024-03-27T10:50:31","guid":{"rendered":"https:\/\/churchtools.academy\/help\/non-knowledgebase\/uncategorized\/api-documentation\/"},"modified":"2026-10-07T07:58:09","modified_gmt":"2026-10-07T05:58:09","password":"","slug":"api-documentation","status":"publish","type":"docs","link":"https:\/\/churchtools.academy\/en\/help\/system-settings\/api-en\/api-documentation\/","title":{"rendered":"API documentation"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">The RESTful API is documented using the <a href=\"https:\/\/swagger.io\/specification\/\">OpenAPI standard<\/a> (formerly Swagger). Each ChurchTools is delivered with the documentation and can be accessed via a link such as<br><code>https:\/\/meine-gemeinde.church.tools\/api<\/code>.<\/p>\n\n\n\n<aside class=\"wp-block-group ct-box ct-box-blue has-background is-vertical is-layout-flex wp-container-core-group-is-layout-1ccdadb1 wp-block-group-is-layout-flex\" style=\"border-radius:8px;border-left-color:#3e70ce;border-left-width:0.5rem;background-color:#f3f5f7;margin-top:var(--wp--preset--spacing--60);margin-bottom:var(--wp--preset--spacing--60)\">\n<p class=\"wp-block-paragraph\" style=\"margin-top:0.5rem;margin-right:0.5rem;margin-bottom:0rem;margin-left:0.5rem\"><strong>Note<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\" style=\"margin-top:0rem;margin-right:0.5rem;margin-bottom:0.5rem;margin-left:0.5rem\"><code>meine-gemeinde<\/code> must be replaced with the name of your own installation. <\/p>\n<\/aside>\n\n\n\n<div style=\"position:relative;padding-top:56.25%;\"><iframe src=\"https:\/\/player.mediadelivery.net\/embed\/752823\/6b529217-c6a8-4905-94d3-276e69a5d2c3?autoplay=false&#038;loop=false&#038;muted=false&#038;preload=false&#038;responsive=true&#038;includeRum=false\" loading=\"lazy\" style=\"border:0;position:absolute;top:0;height:100%;width:100%;\" allow=\"accelerometer;gyroscope;autoplay;encrypted-media;picture-in-picture;fullscreen;\" allowfullscreen=\"true\"><\/iframe><\/div>\n\n\n\n<p class=\"wp-block-paragraph\">The documentation is integrated with the Swagger UI in ChurchTools. This offers the following advantages:   <\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Simple overview of all available endpoints<\/li>\n\n\n\n<li>Testing: The UI allows requests to be fired directly in the browser to test the API<\/li>\n\n\n\n<li>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.   <\/li>\n<\/ol>\n\n\n\n<aside class=\"wp-block-group ct-box ct-box-blue has-background is-vertical is-layout-flex wp-container-core-group-is-layout-1ccdadb1 wp-block-group-is-layout-flex\" style=\"border-radius:8px;border-left-color:#ef4444;border-left-width:0.5rem;background-color:#fee2e2;margin-top:var(--wp--preset--spacing--60);margin-bottom:var(--wp--preset--spacing--60)\">\n<p class=\"wp-block-paragraph\" style=\"margin-top:0.5rem;margin-right:0.5rem;margin-bottom:0rem;margin-left:0.5rem\"><strong>Warning<\/strong><\/p>\n\n\n\n<p class=\"wp-block-paragraph\" style=\"margin-top:0rem;margin-right:0.5rem;margin-bottom:0.5rem;margin-left:0.5rem\">If the user has a lot of permissions, things can also be changed or deleted via the API.<\/p>\n<\/aside>\n\n\n\n<figure class=\"wp-block-image size-full\"><a href=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1.png\"><img fetchpriority=\"high\" decoding=\"async\" width=\"2102\" height=\"1512\" src=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1.png\" alt=\"ChurchTools REST API\" class=\"wp-image-45066\" srcset=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1.png 2102w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1-300x216.png 300w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1-1024x737.png 1024w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1-768x552.png 768w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1-1536x1105.png 1536w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1-2048x1473.png 2048w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/ChurchTools-REST-API-1-360x259.png 360w\" sizes=\"(max-width: 2102px) 100vw, 2102px\" \/><\/a><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">API specification as JSON file<\/h2>\n\n\n\n<p class=\"wp-block-paragraph\">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 <code>https:\/\/meine-gemeinde.church.tools\/system\/runtime\/swagger\/openapi.json<\/code>. <\/p>\n\n\n\n<aside class=\"wp-block-group ct-artikel-zum-weiterlesen has-background is-layout-constrained wp-container-core-group-is-layout-79a8db7e wp-block-group-is-layout-constrained\" style=\"border-radius:8px;background-color:#f9fafb;margin-top:24px;margin-bottom:24px;padding-top:32px;padding-right:24px;padding-bottom:32px;padding-left:24px\">\n<h2 class=\"wp-block-heading has-medium-font-size\">Read more<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/churchtools.academy\/en\/help\/system-settings\/api-en\/overview-api\/\" data-type=\"docs\" data-id=\"7251\">Overview API<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/churchtools.academy\/en\/help\/system-settings\/api-en\/api-authentication\/\" type=\"docs\" id=\"7252\">API authentication<\/a><\/li>\n<\/ul>\n<\/aside>\n","protected":false},"excerpt":{"rendered":"<p>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 ashttps:\/\/meine-gemeinde.church.tools\/api. The documentation is integrated with the Swagger UI in ChurchTools. This offers the following advantages: API specification as JSON file The standard makes it possible to use the [&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],"doc_tag":[653],"knowledge_base":[425],"class_list":["post-45041","docs","type-docs","status-publish","hentry","doc_category-api-en","doc_tag-content-outdated-en","knowledge_base-system-settings"],"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","pp_force_visibility":null,"pp_subpost_visibility":null,"pp_inherited_force_visibility":null,"pp_inherited_subpost_visibility":null,"acf":[],"year_month":"2026-11","word_count":146,"total_views":"1006","reactions":{"happy":"0","normal":"0","sad":"0"},"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\/"}],"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\/45041","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=45041"}],"version-history":[{"count":15,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/45041\/revisions"}],"predecessor-version":[{"id":97615,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/45041\/revisions\/97615"}],"wp:attachment":[{"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/media?parent=45041"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/doc_category?post=45041"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/doc_tag?post=45041"},{"taxonomy":"knowledge_base","embeddable":true,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/knowledge_base?post=45041"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}