{"id":7253,"date":"2024-03-27T12:50:31","date_gmt":"2024-03-27T10:50:31","guid":{"rendered":"https:\/\/churchtools.academy\/?post_type=docs&#038;p=7253"},"modified":"2026-01-28T13:09:16","modified_gmt":"2026-01-28T12:09:16","password":"","slug":"api-dokumentation","status":"publish","type":"docs","link":"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/api-dokumentation\/","title":{"rendered":"API Dokumentation"},"content":{"rendered":"\n<p>Die RESTful API wird mit dem <a href=\"https:\/\/swagger.io\/specification\/\">OpenAPI Standard<\/a> (ehemals Swagger) dokumentiert. Jedes ChurchTools wird mit der Dokumentation ausgeliefert und kann \u00fcber einen Link wie <code>https:\/\/meine-gemeinde.church.tools\/api<\/code> aufgerufen werden. &nbsp;<\/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>Hinweis<\/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> muss hierbei ersetzt werden mit dem Namen der eigenen 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>Die Dokumenation ist mit der Swagger-UI in ChurchTools integriert. Das bietet folgende Vorteile: &nbsp;<\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li>Einfacher \u00dcberblick \u00fcber alle verf\u00fcgbaren Endpoints<\/li>\n\n\n\n<li>Testen: Die UI erlaubt es, direkt im Browser Requests abzufeuern und so die API zu testen<\/li>\n\n\n\n<li>ChurchTools-User: Ist man in ChurchTools eingeloggt, werden alle Requests \u00fcber die UI direkt mit dem eigenen Benutzer gesendet. So kann man die API schnell und einfach testen. &nbsp;<\/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>Achtung<\/strong><\/p>\n\n\n\n<p style=\"margin-top:0rem;margin-right:0.5rem;margin-bottom:0.5rem;margin-left:0.5rem\">Sollte der eigene Benutzer viele Berechtigungen besitzen, k\u00f6nnen \u00fcber die API auch Dinge ge\u00e4ndert oder gel\u00f6scht werden.<\/p>\n<\/aside>\n\n\n\n<figure class=\"wp-block-image size-full\"><a href=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API.png\"><img fetchpriority=\"high\" decoding=\"async\" width=\"2004\" height=\"1460\" src=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API.png\" alt=\"ChurchTools REST API\" class=\"wp-image-45063\" srcset=\"https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API.png 2004w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-300x219.png 300w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-1024x746.png 1024w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-768x560.png 768w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-1536x1119.png 1536w, https:\/\/churchtools.academy\/wp-content\/uploads\/2024\/03\/CTCstable_ChurchTools-REST-API-360x262.png 360w\" sizes=\"(max-width: 2004px) 100vw, 2004px\" \/><\/a><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">API-Spezifikation als JSON-Datei<\/h2>\n\n\n\n<p>Durch den Standard ist es m\u00f6glich, die ganze Dokumentation als JSON-Datei f\u00fcr eigene Projekte heranzuziehen. Die ganze Spezifikation ist \u00fcber den Link <code>https:\/\/meine-gemeinde.church.tools\/system\/runtime\/swagger\/openapi.json<\/code> erreichbar.<\/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\">Artikel zum Weiterlesen<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/0-api\/\" data-type=\"docs\" data-id=\"7251\">\u00dcberblick 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 Authentifizierung<\/a><\/li>\n<\/ul>\n<\/aside>\n","protected":false},"excerpt":{"rendered":"<p>Die RESTful API wird mit dem OpenAPI Standard (ehemals Swagger) dokumentiert. Jedes ChurchTools wird mit der Dokumentation ausgeliefert und kann \u00fcber einen Link wie https:\/\/meine-gemeinde.church.tools\/api aufgerufen werden. &nbsp; Die Dokumenation ist mit der Swagger-UI in ChurchTools integriert. Das bietet folgende Vorteile: &nbsp; API-Spezifikation als JSON-Datei Durch den Standard ist es m\u00f6glich, die ganze Dokumentation als [&hellip;]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"doc_category":[370],"doc_tag":[268],"knowledge_base":[346],"class_list":["post-7253","docs","type-docs","status-publish","hentry","doc_category-api","doc_tag-inhalt-veraltet","knowledge_base-system-einstellungen"],"pp_statuses_selecting_workflow":false,"pp_workflow_action":"current","pp_status_selection":"publish","acf":[],"year_month":"2026-05","word_count":141,"total_views":"3656","reactions":{"happy":"0","normal":"1","sad":"2"},"author_info":{"name":"Victoria Weidemann","author_nicename":"vweidemann","author_url":"https:\/\/churchtools.academy\/de\/author\/vweidemann\/"},"doc_category_info":[{"term_name":"API","term_url":"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/api\/"}],"doc_tag_info":[{"term_name":"Inhalt veraltet","term_url":"https:\/\/churchtools.academy\/de\/docs-tag\/inhalt-veraltet\/"}],"knowledge_base_info":[{"term_name":"System-Einstellungen","term_url":"https:\/\/churchtools.academy\/de\/help\/system-einstellungen\/","term_slug":"system-einstellungen"}],"knowledge_base_slug":["system-einstellungen"],"_links":{"self":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs\/7253","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/comments?post=7253"}],"version-history":[{"count":11,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs\/7253\/revisions"}],"predecessor-version":[{"id":45064,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/docs\/7253\/revisions\/45064"}],"wp:attachment":[{"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/media?parent=7253"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/doc_category?post=7253"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/doc_tag?post=7253"},{"taxonomy":"knowledge_base","embeddable":true,"href":"https:\/\/churchtools.academy\/de\/wp-json\/wp\/v2\/knowledge_base?post=7253"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}