Entwickler MCP-Server
MCP-Server: CLUP.life für KI-Assistenten
Der MCP-Server von CLUP.life: Einrichtung in Claude Desktop, Claude Code und anderen Clients, alle Werkzeuge, Berechtigungen und Sicherheitshinweise.
CLUP.life spricht das Model Context Protocol (MCP). Damit kann ein KI-Assistent Fragen wie „Was steht diese Woche im Verein an?“ beantworten oder den Entwurf einer Mitteilung vorbereiten — mit denselben Rechten wie die Person hinter dem Schlüssel.
Eckdaten#
| Adresse | https://api.clup.life/api/v1/ext/mcp (Ausweichadresse …/ext/assistant, falls eine Netzwerkschicht den Pfadteil „mcp“ verfälscht) |
| Transport | Streamable HTTP, zustandslos, JSON-RPC 2.0; nur POST (ein GET antwortet 405) |
| Anmeldung | Kopf Authorization: Bearer clup_k_… (derselbe API-Schlüssel wie bei REST) |
| Methoden | initialize, ping, tools/list, tools/call; Stapel bis 20 Aufrufe |
| Limit | 600 Aufrufe/Minute am Endpunkt, zusätzlich das Limit des Schlüssels |
Einrichtung Schritt für Schritt#
1. Schlüssel anlegen
Einstellungen → Schnittstellen: Für Zusammenfassungen („Was steht an?“) genügt ein Personenschlüssel nur mit lesenden Bereichen (profile:read, events:read, optional posts:read, announcements:read, tasks:read). Schreibende Werkzeuge brauchen einen Organisationsschlüssel (Premium).
2. Claude Code
claude mcp add --transport http clup https://api.clup.life/api/v1/ext/mcp \
--header "Authorization: Bearer clup_k_…"
# prüfen
claude mcp list3. Claude Desktop
Claude Desktop startet lokale Server. Verbinde den entfernten Server über die Brücke mcp-remote (benötigt Node.js). Öffne Einstellungen → Entwickler → Konfiguration bearbeiten und ergänze claude_desktop_config.json:
{
"mcpServers": {
"clup": {
"command": "npx",
"args": [
"-y", "mcp-remote",
"https://api.clup.life/api/v1/ext/mcp",
"--header", "Authorization:Bearer clup_k_…"
]
}
}
}Claude Desktop danach vollständig beenden und neu starten. Unter dem Werkzeug-Symbol erscheinen die clup_…-Werkzeuge.
4. Andere Clients und eigene Agenten
Trage in einem MCP-fähigen Client (Cursor, VS Code, Windsurf, eigene Agenten über ein MCP-SDK) die Server-Adresse und den Kopf Authorization: Bearer clup_k_… ein; Transport „Streamable HTTP“. Clients, die nur lokale Prozesse kennen, nutzen wie Claude Desktop mcp-remote.
5. Testen
Frage zum Beispiel: „Fasse die Termine der nächsten 14 Tage für tus-musterstadt zusammen.“ Oder per Hand:
curl -s https://api.clup.life/api/v1/ext/mcp \
-H "Authorization: Bearer $CLUP_API_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json, text/event-stream" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'Werkzeuge#
Ein Client sieht nur die Werkzeuge, deren Bereich der Schlüssel trägt; der Aufruf prüft den Bereich noch einmal. Die Liste wird aus der Werkzeugliste des Servers erzeugt.
clup_whoamilesend
Zeigt das Konto hinter dem Schlüssel, seine Bereiche und die Mitgliedschaften (mit slug der Organisationen).
Bereich: profile:read
clup_search_organizationslesend
Sucht öffentliche Vereine, Gruppen und Verbände (Name, Ort, Umkreis, Thema, Bundesland, Altersgruppe, Größe, Gründungsjahr). Nur öffentliche Angaben.
Bereich: directory:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
q | string | nein | |
place | string | nein | Ort oder PLZ |
radiusKm | number | nein | |
categories | string | nein | Themen, getrennt mit | |
state | string | nein | z. B. DE-RP |
ageFrom | number | nein | |
ageTo | number | nein | |
accepting | boolean | nein | |
sort | string | nein | relevance | distance | name | size | new |
limit | number | nein | |
cursor | string | nein |
clup_list_eventslesend
Termine in einem Zeitraum (höchstens 400 Tage), nur solche, die die Person sehen darf.
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
from | string | ja | ISO 8601 |
to | string | ja | ISO 8601 |
organization | string | nein | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
clup_create_eventschreibend
Legt einen Termin in der Organisation des Schlüssels an (nur Schlüssel einer Organisation, nur mit passender Rolle).
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
title | string | ja | |
startsAt | string | ja | |
endsAt | string | nein | |
description | string | nein | |
locationName | string | nein | |
locationStreet | string | nein | |
locationPostalCode | string | nein | |
locationCity | string | nein | |
visibility | string | nein | MEMBERS | PUBLIC | INVITED_ONLY |
participationMode | string | nein | OPEN | GUESTS_REGISTER | MEMBERS_ONLY | INVITED_ONLY |
attendanceMode | string | nein | IN_PERSON | ONLINE | HYBRID |
accessibilityFeatures | array | nein | Katalogcodes der Barrierefreiheit, z. B. STEP_FREE |
clup_list_memberslesend
Mitglieder der Organisation (nur soweit die Rolle der Person die Liste zeigt).
Bereich: members:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
q | string | nein | |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_list_postslesend
Beiträge der Organisation.
Bereich: posts:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_list_newslesend
Öffentliche News der Organisation (nur Beiträge der Sichtbarkeit „öffentlich“; der Newsfeed muss eingeschaltet sein).
Bereich: news:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_list_decisionslesend
Beschlussregister der Organisation (Beschlüsse und Entscheidungen); Mitglieder sehen nur für alle Mitglieder freigegebene Einträge. Optional Suche, Stand (GUELTIG, UMGESETZT, AUFGEHOBEN, ERSETZT) und Zeitraum.
Bereich: decisions:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
q | string | nein | Suchbegriff (Titel, Wortlaut, Schlagworte) |
status | string | nein | Stand, mehrere mit Komma, z. B. "GUELTIG,UMGESETZT" |
from | string | nein | Beschlossen ab (JJJJ-MM-TT) |
to | string | nein | Beschlossen bis (JJJJ-MM-TT) |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_search_fundinglesend
Fördermittel suchen: Fördertopfverzeichnis von CLUP.life (nur öffentlich sichtbare Einträge). Filter nach Stichwort, Geber (BUND, LAND, KOMMUNE, EU, STIFTUNG, VERBAND), Förderart, Thema (z. B. SPORT, JUGEND), Region (Bundesland wie DE-RP) und Stand. Angaben ohne Gewähr, maßgeblich ist die Originalquelle (Link im Eintrag).
Bereich: foerderung:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
q | string | nein | Suchbegriff |
geber | string | nein | Geberart, mehrere mit Komma: BUND, LAND, KOMMUNE, EU, STIFTUNG, VERBAND, SONSTIGE |
thema | string | nein | Themen, mehrere mit Komma: SPORT, JUGEND, KULTUR, EHRENAMT, DIGITALISIERUNG, INKLUSION, KLIMA, BILDUNG, SOZIALES, INTEGRATION, SENIOREN, GESUNDHEIT |
region | string | nein | Bundesland (ISO, z. B. DE-RP) oder PLZ:55218 |
status | string | nein | GEPLANT, OFFEN, LAUFEND, UNBEKANNT (mehrere mit Komma) |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_list_announcementslesend
Mitteilungen (Ankündigungen) der Organisation.
Bereich: announcements:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_create_announcementschreibend
Veröffentlicht eine Mitteilung in der Organisation des Schlüssels (benachrichtigt Mitglieder — nur auf ausdrücklichen Wunsch der Person verwenden).
Bereich: announcements:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
title | string | ja | |
body | string | ja | |
pinned | boolean | nein |
clup_list_taskslesend
Aufgaben der Gruppe (offen oder erledigt).
Bereich: tasks:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
scope | string | nein | open | done |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_list_task_listslesend
Aufgabenlisten der Organisation (die die Person hinter dem Schlüssel sehen darf) mit Zahlen: offen, überfällig, erledigt.
Bereich: tasks:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
clup_list_task_itemslesend
Aufgaben einer Liste (listId, oder „general“ für Aufgaben ohne Liste, sonst alle sichtbaren) mit Status, Priorität und Zuständigen.
Bereich: tasks:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
listId | string | nein | |
scope | string | nein | open | done |
status | string | nein | OPEN | IN_PROGRESS | DONE | DEFERRED |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_create_taskschreibend
Legt eine Aufgabe in der Organisation des Schlüssels an, optional in einer Aufgabenliste (listId).
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organization | string | ja | Kennung (slug) der Organisation, z. B. "tus-musterstadt" |
title | string | ja | |
dueDate | string | nein | JJJJ-MM-TT |
listId | string | nein | |
priority | string | nein | LOW | NORMAL | HIGH |
assigneePublicId | string | nein |
clup_list_press_postslesend
Veröffentlichte Pressemeldungen und News der CLUP.life-Plattform (öffentliche Inhalte), neueste zuerst.
Bereich: presse:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
art | string | nein | PRESS_RELEASE | NEWS |
lang | string | nein | Sprachcode, z. B. de, en |
cursor | string | nein | nextCursor der vorigen Antwort |
limit | integer | nein |
clup_get_press_postlesend
Ein Beitrag per slug; mit Schlüssel mit presse:write auch per Kennung (id) inklusive Entwurf und aller Sprachen.
Bereich: presse:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
ref | string | ja | slug oder Kennung (id) |
lang | string | nein |
clup_create_press_draftschreibend
Legt eine Pressemeldung oder News als ENTWURF an (nur Plattform-Schlüssel, nur mit Plattformrecht Presse). Pressemeldungen brauchen Texte in de und en.
Bereich: presse:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
kind | string | ja | PRESS_RELEASE | NEWS |
slug | string | ja | URL-Kennung: Kleinbuchstaben, Ziffern, Bindestriche |
texts | array | ja | |
coverImage | string | nein | |
coverCredit | string | nein |
clup_update_press_postschreibend
Ändert einen Beitrag (ersetzt Texte und Anhänge; alle Felder wie beim Anlegen). Nur Plattform-Schlüssel mit Plattformrecht Presse.
Bereich: presse:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | |
kind | string | ja | PRESS_RELEASE | NEWS |
slug | string | ja | |
texts | array | ja | |
coverImage | string | nein | |
coverCredit | string | nein |
clup_publish_press_postschreibend
Veröffentlicht einen Beitrag SOFORT und öffentlich — nur auf ausdrücklichen Wunsch der Person verwenden.
Bereich: presse:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja |
clup_schedule_press_postschreibend
Plant die Veröffentlichung eines Beitrags für einen künftigen Zeitpunkt (Sperrfrist); der Zeitgeber veröffentlicht ihn dann.
Bereich: presse:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | |
publishAt | string | ja | ISO 8601, z. B. 2026-11-01T08:00:00Z |
clup_get_eventlesend
Einen Termin lesen (GET /api/v1/events/:id).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_update_eventschreibend
Termin ändern (PATCH /api/v1/events/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_eventschreibend
Termin absagen oder löschen (DELETE /api/v1/events/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: events:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_organization_eventslesend
Termine einer Organisation lesen (GET /api/v1/organizations/:orgId/events).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_participantslesend
Zu- und Absagen eines Termins lesen (GET /api/v1/events/:id/participants).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_respondschreibend
Auf einen Termin zu- oder absagen (POST /api/v1/events/:id/respond). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_event_commentslesend
Kommentare eines Termins lesen (GET /api/v1/events/:id/comments).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_comment_createschreibend
Einen Termin kommentieren (POST /api/v1/events/:id/comments). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_event_agendalesend
Programm eines Termins lesen (GET /api/v1/events/:id/agenda).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_agenda_setschreibend
Programm eines Termins setzen (PUT /api/v1/events/:id/agenda). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_event_bringlesend
Mitbringliste lesen (GET /api/v1/events/:id/bring).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_bring_addschreibend
Mitbringliste ergänzen (POST /api/v1/events/:id/bring). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_event_attendancelesend
Anwesenheit eines Termins lesen (GET /api/v1/events/:id/attendance).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_attendance_setschreibend
Anwesenheit eintragen (PUT /api/v1/events/:id/attendance). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_event_shiftslesend
Dienste eines Termins lesen (GET /api/v1/events/:id/shifts).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_rideslesend
Fahrgemeinschaften lesen (GET /api/v1/events/:id/rides).
Bereich: events:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_event_inviteschreibend
Personen zu einem Termin einladen (POST /api/v1/events/:id/invite). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: events:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_get_postlesend
Einen Beitrag lesen (GET /api/v1/posts/:id).
Bereich: posts:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_postschreibend
Beitrag veröffentlichen (POST /api/v1/posts). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: posts:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_postschreibend
Beitrag ändern (PATCH /api/v1/posts/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: posts:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_postschreibend
Beitrag löschen (DELETE /api/v1/posts/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: posts:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_post_commentslesend
Kommentare eines Beitrags lesen (GET /api/v1/posts/:id/comments).
Bereich: posts:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_post_comment_createschreibend
Beitrag kommentieren (POST /api/v1/posts/:id/comments). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: posts:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_post_pinschreibend
Beitrag anheften (POST /api/v1/posts/:id/pin). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: posts:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_list_scheduled_postslesend
Geplante Beiträge lesen (GET /api/v1/organizations/:orgId/posts/scheduled).
Bereich: posts:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_delete_announcementschreibend
Mitteilung löschen (DELETE /api/v1/announcements/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: announcements:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_announcement_missinglesend
Wer eine Mitteilung noch nicht gelesen hat (GET /api/v1/announcements/:id/missing).
Bereich: announcements:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_task_itemlesend
Eine Aufgabe lesen (GET /api/v1/task-items/:id).
Bereich: tasks:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_task_itemschreibend
Aufgabe in einer Liste anlegen (POST /api/v1/organizations/:orgId/task-items). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_task_itemschreibend
Aufgabe ändern (PATCH /api/v1/task-items/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_set_task_statusschreibend
Aufgabenstatus setzen (PUT /api/v1/task-items/:id/status). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_claim_taskschreibend
Aufgabe übernehmen (POST /api/v1/task-items/:id/claim). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_task_itemschreibend
Aufgabe löschen (DELETE /api/v1/task-items/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: tasks:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_task_commentslesend
Kommentare einer Aufgabe lesen (GET /api/v1/task-items/:id/comments).
Bereich: tasks:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_task_comment_createschreibend
Aufgabe kommentieren (POST /api/v1/task-items/:id/comments). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_create_task_listschreibend
Aufgabenliste anlegen (POST /api/v1/organizations/:orgId/task-lists). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_task_listschreibend
Aufgabenliste ändern (PATCH /api/v1/task-lists/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: tasks:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_task_listschreibend
Aufgabenliste löschen (DELETE /api/v1/task-lists/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: tasks:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_task_statslesend
Aufgaben-Auswertung lesen (GET /api/v1/organizations/:orgId/task-stats).
Bereich: tasks:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_list_pollslesend
Umfragen lesen (GET /api/v1/organizations/:orgId/polls).
Bereich: polls:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_polllesend
Eine Umfrage lesen (GET /api/v1/polls/:id).
Bereich: polls:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_pollschreibend
Umfrage anlegen (POST /api/v1/organizations/:orgId/polls). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: polls:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_vote_pollschreibend
An einer Umfrage abstimmen (PUT /api/v1/polls/:id/votes). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: polls:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_close_pollschreibend
Umfrage beenden (POST /api/v1/polls/:id/close). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: polls:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_pollschreibend
Umfrage löschen (DELETE /api/v1/polls/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: polls:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_resolutionslesend
Digitale Abstimmungen lesen (GET /api/v1/organizations/:orgId/resolutions).
Bereich: resolutions:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_resolutionlesend
Eine digitale Abstimmung lesen (GET /api/v1/resolutions/:id).
Bereich: resolutions:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_resolutionschreibend
Digitale Abstimmung anlegen (POST /api/v1/organizations/:orgId/resolutions). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: resolutions:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_vote_resolutionschreibend
Bei einer digitalen Abstimmung abstimmen (PUT /api/v1/resolutions/:id/vote). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: resolutions:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_close_resolutionschreibend
Digitale Abstimmung abschließen (POST /api/v1/resolutions/:id/close). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: resolutions:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_list_minuteslesend
Protokolle lesen (GET /api/v1/organizations/:orgId/minutes).
Bereich: minutes:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_minuteslesend
Ein Protokoll lesen (GET /api/v1/minutes/:id).
Bereich: minutes:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_minutesschreibend
Protokoll anlegen (POST /api/v1/organizations/:orgId/minutes). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: minutes:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_minutesschreibend
Protokoll ändern (PUT /api/v1/minutes/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: minutes:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_minutesschreibend
Protokoll löschen (DELETE /api/v1/minutes/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: minutes:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_get_decisionlesend
Einen Beschluss lesen (GET /api/v1/organizations/:orgId/beschlussregister/:id).
Bereich: decisions:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_decisionschreibend
Beschluss ins Register eintragen (POST /api/v1/organizations/:orgId/beschlussregister). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: decisions:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_decisionschreibend
Beschluss ändern (PATCH /api/v1/organizations/:orgId/beschlussregister/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: decisions:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_set_decision_statusschreibend
Beschlussstand ändern (z. B. aufheben) (POST /api/v1/organizations/:orgId/beschlussregister/:id/status). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: decisions:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_get_bylawslesend
Satzung lesen (GET /api/v1/organizations/:orgId/bylaws).
Bereich: minutes:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_pending_memberslesend
Offene Beitrittsanfragen lesen (GET /api/v1/organizations/:id/members/pending).
Bereich: members:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_decide_membershipschreibend
Beitrittsanfrage annehmen oder ablehnen (POST /api/v1/organizations/:id/members/:userId/decision). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: members:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
userId | string | ja | Kennung (userId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_set_member_roleschreibend
Rolle eines Mitglieds ändern (PATCH /api/v1/organizations/:id/members/:userId/role). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: members:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
userId | string | ja | Kennung (userId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_list_officeslesend
Ämter lesen (GET /api/v1/organizations/:orgId/offices).
Bereich: offices:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_officeschreibend
Amt anlegen (POST /api/v1/organizations/:orgId/offices). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: offices:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_officeschreibend
Amt ändern (PUT /api/v1/organizations/:orgId/offices/:officeId). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: offices:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
officeId | string | ja | Kennung (officeId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_officeschreibend
Amt löschen (DELETE /api/v1/organizations/:orgId/offices/:officeId). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: offices:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
officeId | string | ja | Kennung (officeId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_add_office_holderschreibend
Amtsinhaber eintragen (POST /api/v1/organizations/:orgId/offices/:officeId/holders). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: offices:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
officeId | string | ja | Kennung (officeId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_end_office_holdingschreibend
Amtszeit beenden (DELETE /api/v1/organizations/:orgId/office-holdings/:holdingId). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: offices:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
holdingId | string | ja | Kennung (holdingId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_roleslesend
Rollen lesen (GET /api/v1/organizations/:orgId/roles).
Bereich: offices:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_list_officerslesend
Vorstand und Leitung lesen (GET /api/v1/organizations/:orgId/officers).
Bereich: offices:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_list_karteilesend
Karteimitglieder lesen (GET /api/v1/organizations/:orgId/karteimitglieder).
Bereich: kartei:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_karteilesend
Ein Karteimitglied lesen (GET /api/v1/organizations/:orgId/karteimitglieder/:id).
Bereich: kartei:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_karteischreibend
Karteimitglied anlegen (POST /api/v1/organizations/:orgId/karteimitglieder). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: kartei:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_karteischreibend
Karteimitglied ändern (PATCH /api/v1/organizations/:orgId/karteimitglieder/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: kartei:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_karteischreibend
Karteimitglied entfernen (DELETE /api/v1/organizations/:orgId/karteimitglieder/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: kartei:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_kartei_birthdayslesend
Geburtstage der Karteimitglieder lesen (GET /api/v1/organizations/:orgId/karteimitglieder/geburtstage).
Bereich: kartei:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_list_documentslesend
Dokumente lesen (GET /api/v1/organizations/:orgId/documents).
Bereich: documents:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_documentschreibend
Dokument anlegen (POST /api/v1/organizations/:orgId/documents). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: documents:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_documentschreibend
Dokument ändern (PATCH /api/v1/documents/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: documents:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_documentschreibend
Dokument löschen (DELETE /api/v1/documents/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: documents:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_fileslesend
Dateiablage lesen (GET /api/v1/organizations/:orgId/ablage).
Bereich: files:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_search_fileslesend
Dateiablage durchsuchen (GET /api/v1/organizations/:orgId/ablage/search).
Bereich: files:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_folderschreibend
Ordner anlegen (POST /api/v1/organizations/:orgId/ablage/folders). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: files:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_rename_folderschreibend
Ordner umbenennen (PATCH /api/v1/organizations/:orgId/ablage/folders/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: files:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_folderschreibend
Ordner in den Papierkorb legen (DELETE /api/v1/organizations/:orgId/ablage/folders/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: files:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_update_fileschreibend
Datei umbenennen (PATCH /api/v1/organizations/:orgId/ablage/files/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: files:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_fileschreibend
Datei in den Papierkorb legen (DELETE /api/v1/organizations/:orgId/ablage/files/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: files:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_files_trashlesend
Papierkorb der Ablage lesen (GET /api/v1/organizations/:orgId/ablage/trash).
Bereich: files:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_restore_fileschreibend
Datei aus dem Papierkorb wiederherstellen (POST /api/v1/organizations/:orgId/ablage/trash/files/:id/restore). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: files:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_restore_folderschreibend
Ordner aus dem Papierkorb wiederherstellen (POST /api/v1/organizations/:orgId/ablage/trash/folders/:id/restore). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: files:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_list_chroniclelesend
Vereinschronik lesen (GET /api/v1/organizations/:orgId/chronicle).
Bereich: chronicle:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_chronicleschreibend
Chronikeintrag anlegen (POST /api/v1/organizations/:orgId/chronicle). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: chronicle:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_chronicleschreibend
Chronikeintrag löschen (DELETE /api/v1/chronicle/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: chronicle:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_honorslesend
Ehrungen lesen (GET /api/v1/organizations/:orgId/honors).
Bereich: awards:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_honorschreibend
Ehrung eintragen (POST /api/v1/organizations/:orgId/honors). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: awards:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_honorschreibend
Ehrung löschen (DELETE /api/v1/honors/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: awards:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_award_typeslesend
Auszeichnungsarten lesen (GET /api/v1/organizations/:orgId/auszeichnungen/arten).
Bereich: awards:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_award_grantschreibend
Auszeichnung vergeben (POST /api/v1/organizations/:orgId/auszeichnungen/arten/:artId/vergaben). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: awards:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
artId | string | ja | Kennung (artId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_award_revokeschreibend
Auszeichnungsvergabe zurücknehmen (DELETE /api/v1/organizations/:orgId/auszeichnungen/vergaben/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: awards:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_inventorylesend
Inventar lesen (GET /api/v1/organizations/:orgId/inventory).
Bereich: inventory:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_inventoryschreibend
Inventar anlegen (POST /api/v1/organizations/:orgId/inventory). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: inventory:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_inventoryschreibend
Inventar löschen (DELETE /api/v1/inventory/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: inventory:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_shiftslesend
Dienste lesen (GET /api/v1/organizations/:orgId/shifts).
Bereich: shifts:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_shiftschreibend
Dienst anlegen (POST /api/v1/organizations/:orgId/shifts). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: shifts:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_shift_signupschreibend
Für einen Dienst eintragen (POST /api/v1/shifts/:id/signup). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: shifts:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_shift_signoffschreibend
Aus einem Dienst austragen (DELETE /api/v1/shifts/:id/signup). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: shifts:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_delete_shiftschreibend
Dienst löschen (DELETE /api/v1/shifts/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: shifts:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_albumslesend
Fotoalben lesen (GET /api/v1/organizations/:orgId/albums).
Bereich: albums:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_albumschreibend
Fotoalbum anlegen (POST /api/v1/organizations/:orgId/albums). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: albums:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_albumschreibend
Fotoalbum löschen (DELETE /api/v1/albums/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: albums:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_matcheslesend
Spiele und Ergebnisse lesen (GET /api/v1/organizations/:orgId/matches).
Bereich: matches:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_matchschreibend
Spiel eintragen (POST /api/v1/organizations/:orgId/matches). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: matches:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_matchschreibend
Spiel ändern (PATCH /api/v1/organizations/:orgId/matches/:matchId). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: matches:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
matchId | string | ja | Kennung (matchId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_matchschreibend
Spiel löschen (DELETE /api/v1/organizations/:orgId/matches/:matchId). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: matches:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
matchId | string | ja | Kennung (matchId) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_dueslesend
Beitragsforderungen lesen (GET /api/v1/organizations/:orgId/dues).
Bereich: finance:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_duesschreibend
Beitragsforderung anlegen (POST /api/v1/organizations/:orgId/dues). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: finance:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_set_dues_statusschreibend
Beitragsstatus vermerken (z. B. bezahlt) (PUT /api/v1/dues/:id/status). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: finance:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_duesschreibend
Beitragsforderung löschen (DELETE /api/v1/dues/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: finance:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_finance_overviewlesend
Finanzübersicht lesen (GET /api/v1/organizations/:orgId/finance/overview).
Bereich: finance:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_ledgerlesend
Buchungsjournal lesen (GET /api/v1/organizations/:orgId/ledger).
Bereich: finance:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_list_donation_callslesend
Spendenaufrufe lesen (GET /api/v1/organizations/:orgId/donations).
Bereich: donations:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_donation_callschreibend
Spendenaufruf anlegen (POST /api/v1/organizations/:orgId/donations). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: donations:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_donation_callschreibend
Spendenaufruf ändern (PATCH /api/v1/donations/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: donations:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_close_donation_callschreibend
Spendenaufruf beenden (POST /api/v1/donations/:id/close). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: donations:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_donation_callschreibend
Spendenaufruf löschen (DELETE /api/v1/donations/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: donations:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_grantslesend
Förderprojekte lesen (GET /api/v1/organizations/:orgId/foerderung/projekte).
Bereich: grants:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_grantlesend
Ein Förderprojekt lesen (GET /api/v1/organizations/:orgId/foerderung/projekte/:id).
Bereich: grants:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_grantschreibend
Förderprojekt anlegen (POST /api/v1/organizations/:orgId/foerderung/projekte). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: grants:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_grantschreibend
Förderprojekt ändern (PATCH /api/v1/organizations/:orgId/foerderung/projekte/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: grants:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_grantschreibend
Förderprojekt löschen (DELETE /api/v1/organizations/:orgId/foerderung/projekte/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: grants:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_grant_deadlineslesend
Fristen der Förderung lesen (GET /api/v1/organizations/:orgId/foerderung/pflichttermine).
Bereich: grants:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_list_jobslesend
Stellen und Gesuche lesen (GET /api/v1/organizations/:orgId/stellen).
Bereich: jobs:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_get_joblesend
Eine Stelle lesen (GET /api/v1/organizations/:orgId/stellen/:id).
Bereich: jobs:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_jobschreibend
Stelle oder Gesuch anlegen (POST /api/v1/organizations/:orgId/stellen). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: jobs:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_update_jobschreibend
Stelle ändern (PATCH /api/v1/organizations/:orgId/stellen/:id). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: jobs:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_set_job_statusschreibend
Stelle veröffentlichen oder schließen (POST /api/v1/organizations/:orgId/stellen/:id/status). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: jobs:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_delete_jobschreibend
Stelle löschen (DELETE /api/v1/organizations/:orgId/stellen/:id). LÖSCHT oder entfernt Daten (wo möglich in den Papierkorb) — nur auf ausdrücklichen Wunsch, confirm: true nötig.
Bereich: jobs:delete · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
confirm | boolean | nein | Muss true sein, sonst wird nicht gelöscht |
clup_list_plannerslesend
Terminfindungen der Organisation lesen (GET /api/v1/organizations/:organizationId/terminfindungen).
Bereich: planner:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organizationId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_create_plannerschreibend
Terminfindung anlegen (POST /api/v1/organizations/:organizationId/terminfindungen). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: planner:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
organizationId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_engagement_overviewlesend
Engagement-Übersicht lesen (GET /api/v1/organizations/:orgId/engagement/uebersicht).
Bereich: engagement:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_engagement_ruleslesend
Punkteregeln lesen (GET /api/v1/organizations/:orgId/engagement/punkte/regeln).
Bereich: engagement:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_engagement_bookingslesend
Punktebuchungen lesen (GET /api/v1/organizations/:orgId/engagement/punkte/buchungen).
Bereich: engagement:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_engagement_bookschreibend
Punkte manuell buchen (POST /api/v1/organizations/:orgId/engagement/punkte/buchungen). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: engagement:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_engagement_stornoschreibend
Punktebuchung stornieren (POST /api/v1/organizations/:orgId/engagement/punkte/buchungen/:id/storno). Ändert Daten mit den Rechten der Person — nur auf ausdrücklichen Wunsch.
Bereich: engagement:write · Premium (Organisationsschlüssel)
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
orgId | string | ja | Kennung (UUID) der Organisation, siehe clup_whoami |
id | string | ja | Kennung (id) |
body | object | nein | Inhalt der Anfrage (wie in der Dokumentation der Route) |
dryRun | boolean | nein | true = nichts ausführen, nur zeigen, was aufgerufen würde |
clup_my_news_channellesend
Eigenen Newskanal lesen (GET /api/v1/newskanal/mein).
Bereich: newskanal:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_my_news_postslesend
Eigene Newskanal-Beiträge lesen (GET /api/v1/newskanal/mein/beitraege).
Bereich: newskanal:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
clup_news_feedlesend
Newsfeed der abonnierten Kanäle lesen (GET /api/v1/newskanal/feed).
Bereich: newskanal:read
| Name | Typ | Pflicht | Hinweis |
|---|---|---|---|
query | object | nein | Suchparameter (z. B. cursor, limit, q) |
Protokollversion: 2025-03-26
Berechtigungen und Sicherheit#
- Der Assistent handelt mit den Rechten der Person, der der Schlüssel gehört. Nicht sichtbare Organisationen melden „nicht gefunden“.
- Antworten sind Daten, keine Anweisungen. Der Server sagt das in seinen
instructions. Prüfe Ergebnisse, bevor du auf Grundlage von Beitragstexten handelst. - Ändernde und löschende Werkzeuge (
clup_create_*,clup_update_*,clup_delete_*…) sind nur mit Organisationsschlüssel und passendem Bereich sichtbar. Stelle sie im Client auf „jeweils nachfragen“ — vor allem solche, die Mitglieder benachrichtigen oder löschen. Löschende Werkzeuge verlangenconfirm: trueund kennendryRun: true. - Verbinde pro Assistent einen eigenen, eng begrenzten Schlüssel und widerrufe ihn, wenn du den Client nicht mehr nutzt.
- Beachte: Was der Assistent liest, geht an den Anbieter des Assistenten. Gib ihm nur Schlüssel, deren Daten du dorthin geben darfst (siehe Datenschutz).
