{"id":45041,"date":"2024-03-27T12:50:31","date_gmt":"2024-03-27T11:50:31","guid":{"rendered":"https:\/\/churchtools.academy\/help\/non-knowledgebase\/uncategorized\/api-documentation\/"},"modified":"2026-03-17T09:51:53","modified_gmt":"2026-03-17T08:51:53","password":"","slug":"api-documentation","status":"publish","type":"docs","link":"https:\/\/churchtools.academy\/en\/help\/system-settings\/api\/api-documentation\/","title":{"rendered":"API documentation"},"content":{"rendered":"\n<p>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-002f1c27 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 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 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<!--presto-player:video_id=23--><figure class=\"wp-block-video presto-block-video  presto-provider-youtube\" style=\"--plyr-color-main: var(--presto-player-highlight-color, #2563eb); --presto-player-logo-width: 150px; \">\n\t<presto-player \n\t\tpreset='{&quot;id&quot;:5,&quot;name&quot;:&quot;YouTube Optimized&quot;,&quot;slug&quot;:&quot;youtube&quot;,&quot;icon&quot;:&quot;youtube&quot;,&quot;skin&quot;:&quot;modern&quot;,&quot;play-large&quot;:true,&quot;rewind&quot;:true,&quot;play&quot;:true,&quot;fast-forward&quot;:true,&quot;progress&quot;:true,&quot;current-time&quot;:true,&quot;mute&quot;:true,&quot;volume&quot;:true,&quot;speed&quot;:true,&quot;pip&quot;:false,&quot;fullscreen&quot;:true,&quot;captions&quot;:false,&quot;reset_on_end&quot;:true,&quot;auto_hide&quot;:true,&quot;show_time_elapsed&quot;:false,&quot;captions_enabled&quot;:false,&quot;save_player_position&quot;:false,&quot;sticky_scroll&quot;:false,&quot;sticky_scroll_position&quot;:&quot;bottom right&quot;,&quot;on_video_end&quot;:&quot;select&quot;,&quot;play_video_viewport&quot;:false,&quot;hide_youtube&quot;:false,&quot;lazy_load_youtube&quot;:true,&quot;hide_logo&quot;:false,&quot;border_radius&quot;:0,&quot;caption_style&quot;:&quot;&quot;,&quot;caption_background&quot;:&quot;&quot;,&quot;is_locked&quot;:true,&quot;cta&quot;:[&quot;&quot;],&quot;watermark&quot;:[&quot;&quot;],&quot;search&quot;:[&quot;&quot;],&quot;email_collection&quot;:[&quot;&quot;],&quot;created_by&quot;:4,&quot;created_at&quot;:&quot;2024-06-20 11:19:03&quot;,&quot;updated_at&quot;:&quot;2024-06-20 11:19:03&quot;,&quot;deleted_at&quot;:&quot;&quot;}'\n\t\tbranding='{&quot;logo&quot;:&quot;&quot;,&quot;color&quot;:&quot;#2563eb&quot;,&quot;logo_width&quot;:150,&quot;player_css&quot;:&quot;&quot;}'\n\t\tchapters='[]'\n\t\toverlays='[]'\n\t\ttracks='[]'\n\t\tblock-attributes='{&quot;playsInline&quot;:true,&quot;id&quot;:23,&quot;src&quot;:&quot;https:\\\/\\\/www.youtube.com\\\/watch?v=a2dWZTOnGFM&quot;,&quot;preset&quot;:5,&quot;video_id&quot;:&quot;a2dWZTOnGFM&quot;,&quot;title&quot;:&quot;ChurchTools API - \\u00dcberblick&quot;}'\n\t\tanalytics=''\n\t\tautomations\t\tprovider='youtube'\n\t\t\t\tid=\"presto-player-1\"\n\t\tsrc=\"\/\/www.youtube.com\/embed\/a2dWZTOnGFM?iv_load_policy=3&amp;modestbranding=1&amp;playinline=1&amp;showinfo=0&amp;rel=0&amp;enablejsapi=1\"\n\t\tmedia-title=\"ChurchTools API - \u00dcberblick\"\n\t\tcss=\"\"\n\t\tclass=\"presto-video-id-23 presto-preset-id-5 skin-modern\"\n\t\tskin=\"modern\" \n\t\ticon-url=\"https:\/\/churchtools.academy\/wp-content\/plugins\/presto-player\/img\/sprite.svg\" \n\t\tpreload=\"\" \n\t\tposter=\"\"\n\t\tyoutube=\"{&quot;noCookie&quot;:true,&quot;channelId&quot;:&quot;&quot;,&quot;show_count&quot;:false}\"\n\t\tprovider-video-id=\"a2dWZTOnGFM\"\n\t\tvideo-id=\"23\"\n\t\tlazy-load-youtube\t\tplaysinline \n\t\t\t\t>\n\t\t\n\n\t<\/presto-player>\n<\/figure>\n\n\n<p>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-002f1c27 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 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 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>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-89fd719a 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\/overview-api\/\" data-type=\"docs\" data-id=\"7251\">Overview API<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/0-api-authentifizierung\/\" data-type=\"docs\" data-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,461],"doc_tag":[653],"knowledge_base":[425],"class_list":{"0":"post-45041","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":146,"total_views":"568","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\/"},{"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":7,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/45041\/revisions"}],"predecessor-version":[{"id":50079,"href":"https:\/\/churchtools.academy\/en\/wp-json\/wp\/v2\/docs\/45041\/revisions\/50079"}],"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}]}}