Entwickler API-Referenz
API-Referenz
Alle Routen der CLUP.life-REST-API v1 mit Parametern, Antworten und Beispielen — erzeugt aus der OpenAPI-Beschreibung. Download als JSON und YAML.
Diese Referenz wird beim Aufruf der Seite aus der echten OpenAPI-Beschreibung erzeugt; sie kann nicht von der Schnittstelle abweichen. Ein Test in der Entwicklung scheitert, sobald eine Route fehlt oder die Beschreibung nicht mehr zur Dokumentation passt.
Basisadresse: https://api.clup.life/api/v1 · OpenAPI 3.1.0 · Version 1.0.0
GET /ext/me
GET/ext/me
Wer bin ich? Konto, Bereiche des Schlüssels, Mitgliedschaften
Bereiche: profile:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/me"GET /ext/directory/organizations
GET/ext/directory/organizations
Vereinsverzeichnis durchsuchen (nur öffentliche Organisationen)
Bereiche: directory:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
q | Abfrage | nein | Name, Kurzname oder Ort |
categories | Abfrage | nein | Themen, getrennt mit | |
types | Abfrage | nein | CLUB, ASSOCIATION, GROUP, MUNICIPALITY (kommagetrennt) |
state | Abfrage | nein | Bundesland als Code, z. B. DE-RP (kommagetrennt) |
place | Abfrage | nein | Ort oder Postleitzahl |
radiusKm | Abfrage | nein | Umkreis 1–300 (mit place) |
ageFrom | Abfrage | nein | Angebot für Alter von |
ageTo | Abfrage | nein | Angebot für Alter bis |
membersMin | Abfrage | nein | Mindestzahl Mitglieder |
membersMax | Abfrage | nein | Höchstzahl Mitglieder |
foundedFrom | Abfrage | nein | Gegründet ab (Jahr) |
foundedTo | Abfrage | nein | Gegründet bis (Jahr) |
accepting | Abfrage | nein | 1 = nimmt neue Mitglieder auf |
sort | Abfrage | nein | relevance, distance, name, size oder new |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/directory/organizations"GET /ext/events
GET/ext/events
Termine eines Zeitraums
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
from | Abfrage | ja | Beginn des Zeitraums (ISO 8601, z. B. 2026-11-01T00:00:00Z) |
to | Abfrage | ja | Ende des Zeitraums (höchstens 400 Tage nach from) |
organization | Abfrage | nein | Nur Termine dieser Organisation (slug) |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/events?from=2026-11-01T00:00:00Z&to=2026-12-01T00:00:00Z"POST /ext/organizations/{org}/events
POST/ext/organizations/{org}/events
Termin anlegen
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
{
"title": "Sommerfest",
"startsAt": "2026-07-04T14:00:00Z",
"endsAt": "2026-07-04T20:00:00Z",
"visibility": "MEMBERS"
}| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -X POST -H "Authorization: Bearer clup_k_…" \
-H "Content-Type: application/json" \
-d '{"title":"Sommerfest","startsAt":"2026-07-04T14:00:00Z","endsAt":"2026-07-04T20:00:00Z","visibility":"MEMBERS"}' \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/events"GET /ext/organizations/{org}/members
GET/ext/organizations/{org}/members
Mitgliederliste (nur wenn die Rolle der Person sie zeigt)
Bereiche: members:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
q | Abfrage | nein | Suche im Anzeigenamen |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/members"GET /ext/organizations/{org}/posts
GET/ext/organizations/{org}/posts
Beiträge
Bereiche: posts:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/posts"GET /ext/organizations/{org}/news
GET/ext/organizations/{org}/news
Öffentliche News (nur Sichtbarkeit „öffentlich“, nur bei eingeschaltetem Newsfeed)
Bereiche: news:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/news"GET /ext/organizations/{org}/decisions
GET/ext/organizations/{org}/decisions
Beschlussregister (Leitung: alles, Mitglieder: nur freigegebene), mit Suche und Filtern
Bereiche: decisions:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
q | Abfrage | nein | Suche in Titel, Beschlusstext, Begründung, Schlagworten und Nummer |
status | Abfrage | nein | GUELTIG, UMGESETZT, AUFGEHOBEN oder ERSETZT (mehrere mit Komma) |
from | Abfrage | nein | Beschlossen ab (JJJJ-MM-TT) |
to | Abfrage | nein | Beschlossen bis (JJJJ-MM-TT) |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/decisions"GET /ext/funding
GET/ext/funding
Fördertopfverzeichnis durchsuchen (nur öffentlich sichtbare Einträge, ohne Kontakt; Angaben ohne Gewähr, Originalquelle maßgeblich)
Bereiche: foerderung:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
q | Abfrage | nein | Suchbegriff (Volltext in Titel, Geber, Beschreibung) |
geber | Abfrage | nein | BUND, LAND, KOMMUNE, EU, STIFTUNG, VERBAND, SONSTIGE (mehrere mit Komma) |
art | Abfrage | nein | ZUSCHUSS, DARLEHEN, SACHLEISTUNG, PREIS, SONSTIGE (mehrere mit Komma) |
zielgruppe | Abfrage | nein | VEREIN, VERBAND, GRUPPE, KOMMUNE, GEMEINNUETZIG, JUGENDARBEIT (mehrere mit Komma) |
thema | Abfrage | nein | SPORT, JUGEND, KULTUR, EHRENAMT, DIGITALISIERUNG, INKLUSION, KLIMA, BILDUNG, SOZIALES, INTEGRATION, SENIOREN, GESUNDHEIT (mehrere mit Komma) |
region | Abfrage | nein | Bundesland (z. B. DE-RP) oder PLZ:55218 |
status | Abfrage | nein | GEPLANT, OFFEN, LAUFEND, UNBEKANNT (mehrere mit Komma) |
sort | Abfrage | nein | NEU (Standard) oder FRIST |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/funding"GET /ext/organizations/{org}/announcements
GET/ext/organizations/{org}/announcements
Mitteilungen
Bereiche: announcements:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/announcements"POST /ext/organizations/{org}/announcements
POST/ext/organizations/{org}/announcements
Mitteilung veröffentlichen
Bereiche: announcements:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
{
"title": "Hallenzeiten ändern sich",
"body": "Ab Montag trainieren wir in der kleinen Halle."
}| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -X POST -H "Authorization: Bearer clup_k_…" \
-H "Content-Type: application/json" \
-d '{"title":"Hallenzeiten ändern sich","body":"Ab Montag trainieren wir in der kleinen Halle."}' \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/announcements"GET /ext/organizations/{org}/tasks
GET/ext/organizations/{org}/tasks
Aufgaben
Bereiche: tasks:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
scope | Abfrage | nein | open (Standard) oder done |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/tasks"POST /ext/organizations/{org}/tasks
POST/ext/organizations/{org}/tasks
Aufgabe anlegen, optional in einer Liste
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
{
"title": "Zelte prüfen",
"dueDate": "2026-06-20",
"priority": "HIGH",
"listId": "<Kennung der Liste>"
}| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -X POST -H "Authorization: Bearer clup_k_…" \
-H "Content-Type: application/json" \
-d '{"title":"Zelte prüfen","dueDate":"2026-06-20","priority":"HIGH","listId":"<Kennung der Liste>"}' \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/tasks"GET /ext/organizations/{org}/task-lists
GET/ext/organizations/{org}/task-lists
Aufgabenlisten mit Zählern (offen, überfällig, erledigt)
Bereiche: tasks:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/task-lists"GET /ext/organizations/{org}/task-items
GET/ext/organizations/{org}/task-items
Aufgaben einer Liste mit Status, Priorität und Zuständigen
Bereiche: tasks:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
listId | Abfrage | nein | Kennung der Liste oder general (ohne Liste); leer = alle sichtbaren |
scope | Abfrage | nein | open (Standard) oder done |
status | Abfrage | nein | OPEN, IN_PROGRESS, DONE oder DEFERRED |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/organizations/mein-verein/task-items"GET /ext/presse/posts
GET/ext/presse/posts
Veröffentlichte Pressemeldungen und News
Bereiche: presse:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
art | Abfrage | nein | PRESS_RELEASE oder NEWS |
lang | Abfrage | nein | Sprachcode, z. B. de, en (Rückfall Deutsch) |
cursor | Abfrage | nein | Fortsetzung aus nextCursor der vorigen Antwort (keine Seitenzahlen, kein OFFSET) |
limit | Abfrage | nein | 1–100, Standard 30 |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/presse/posts"POST /ext/presse/posts
POST/ext/presse/posts
Pressemeldung oder News als Entwurf anlegen
Bereiche: presse:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
{
"kind": "NEWS",
"slug": "neue-funktion",
"texts": [
{
"locale": "de",
"title": "Neue Funktion",
"summary": "Kurzer Anreißer der Meldung.",
"body": "Text in einfachem Markdown."
}
]
}| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -X POST -H "Authorization: Bearer clup_k_…" \
-H "Content-Type: application/json" \
-d '{"kind":"NEWS","slug":"neue-funktion","texts":[{"locale":"de","title":"Neue Funktion","summary":"Kurzer Anreißer der Meldung.","body":"Text in einfachem Markdown."}]}' \
"https://api.clup.life/api/v1/ext/presse/posts"GET /ext/presse/posts/{ref}
GET/ext/presse/posts/{ref}
Ein Beitrag per slug (mit presse:write auch per Kennung, inkl. Entwurf)
Bereiche: presse:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
ref | Pfad | ja | slug oder Kennung des Beitrags |
lang | Abfrage | nein | Sprachcode, z. B. de, en (Rückfall Deutsch) |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/presse/posts/{ref}"PUT /ext/presse/posts/{id}
PUT/ext/presse/posts/{id}
Beitrag ändern
Bereiche: presse:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung des Beitrags |
{
"kind": "NEWS",
"slug": "neue-funktion",
"texts": [
{
"locale": "de",
"title": "Neue Funktion",
"summary": "Kurzer Anreißer der Meldung.",
"body": "Geänderter Text."
}
]
}| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
-H "Content-Type: application/json" \
-d '{"kind":"NEWS","slug":"neue-funktion","texts":[{"locale":"de","title":"Neue Funktion","summary":"Kurzer Anreißer der Meldung.","body":"Geänderter Text."}]}' \
"https://api.clup.life/api/v1/ext/presse/posts/{id}"POST /ext/presse/posts/{id}/publish
POST/ext/presse/posts/{id}/publish
Beitrag jetzt veröffentlichen
Bereiche: presse:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung des Beitrags |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/presse/posts/{id}/publish"POST /ext/presse/posts/{id}/schedule
POST/ext/presse/posts/{id}/schedule
Veröffentlichung planen
Bereiche: presse:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung des Beitrags |
{
"publishAt": "2026-11-01T08:00:00Z"
}| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -X POST -H "Authorization: Bearer clup_k_…" \
-H "Content-Type: application/json" \
-d '{"publishAt":"2026-11-01T08:00:00Z"}' \
"https://api.clup.life/api/v1/ext/presse/posts/{id}/schedule"GET /ext/exports/events.ics
GET/ext/exports/events.ics
Termine als iCal
Bereiche: exports:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
from | Abfrage | ja | Beginn des Zeitraums (ISO 8601, z. B. 2026-11-01T00:00:00Z) |
to | Abfrage | ja | Ende des Zeitraums (höchstens 400 Tage nach from) |
organization | Abfrage | nein | Nur Termine dieser Organisation (slug) |
| Status | Bedeutung |
|---|---|
| 200 (text/calendar) | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/exports/events.ics?from=2026-11-01T00:00:00Z&to=2026-12-01T00:00:00Z"GET /ext/exports/events.csv
GET/ext/exports/events.csv
Termine als CSV
Bereiche: exports:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
from | Abfrage | ja | Beginn des Zeitraums (ISO 8601, z. B. 2026-11-01T00:00:00Z) |
to | Abfrage | ja | Ende des Zeitraums (höchstens 400 Tage nach from) |
organization | Abfrage | nein | Nur Termine dieser Organisation (slug) |
| Status | Bedeutung |
|---|---|
| 200 (text/csv) | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/exports/events.csv?from=2026-11-01T00:00:00Z&to=2026-12-01T00:00:00Z"GET /ext/exports/organizations/{org}/members.csv
GET/ext/exports/organizations/{org}/members.csv
Mitgliederliste als CSV (nur Leitung, protokolliert)
Bereiche: exports:read, members:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
org | Pfad | ja | Kennung (slug) der Organisation |
| Status | Bedeutung |
|---|---|
| 200 (text/csv) | Erfolg |
| 401 | Schlüssel ungültig, abgelaufen oder widerrufen (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Organisationen, die der Schlüssel nicht sehen darf |
| 429 | Zu viele Anfragen (RATE_LIMITED); Retry-After beachten |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/ext/exports/organizations/mein-verein/members.csv"GET /events/{id}
GET/events/{id}
Einen Termin lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}"PATCH /events/{id}
PATCH/events/{id}
Termin ändern
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}"DELETE /events/{id}
DELETE/events/{id}
Termin absagen oder löschen
Bereiche: events:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}"GET /organizations/{orgId}/events
GET/organizations/{orgId}/events
Termine einer Organisation lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/events"GET /events/{id}/participants
GET/events/{id}/participants
Zu- und Absagen eines Termins lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/participants"POST /events/{id}/respond
POST/events/{id}/respond
Auf einen Termin zu- oder absagen
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/respond"GET /events/{id}/comments
GET/events/{id}/comments
Kommentare eines Termins lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/comments"POST /events/{id}/comments
POST/events/{id}/comments
Einen Termin kommentieren
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/comments"GET /events/{id}/agenda
GET/events/{id}/agenda
Programm eines Termins lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/agenda"PUT /events/{id}/agenda
PUT/events/{id}/agenda
Programm eines Termins setzen
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/agenda"GET /events/{id}/bring
GET/events/{id}/bring
Mitbringliste lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/bring"POST /events/{id}/bring
POST/events/{id}/bring
Mitbringliste ergänzen
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/bring"GET /events/{id}/attendance
GET/events/{id}/attendance
Anwesenheit eines Termins lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/attendance"PUT /events/{id}/attendance
PUT/events/{id}/attendance
Anwesenheit eintragen
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/attendance"GET /events/{id}/shifts
GET/events/{id}/shifts
Dienste eines Termins lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/shifts"GET /events/{id}/rides
GET/events/{id}/rides
Fahrgemeinschaften lesen
Bereiche: events:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/rides"POST /events/{id}/invite
POST/events/{id}/invite
Personen zu einem Termin einladen
Bereiche: events:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/events/{id}/invite"GET /posts/{id}
GET/posts/{id}
Einen Beitrag lesen
Bereiche: posts:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts/{id}"PATCH /posts/{id}
PATCH/posts/{id}
Beitrag ändern
Bereiche: posts:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts/{id}"DELETE /posts/{id}
DELETE/posts/{id}
Beitrag löschen
Bereiche: posts:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts/{id}"POST /posts
POST/posts
Beitrag veröffentlichen
Bereiche: posts:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts"GET /posts/{id}/comments
GET/posts/{id}/comments
Kommentare eines Beitrags lesen
Bereiche: posts:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts/{id}/comments"POST /posts/{id}/comments
POST/posts/{id}/comments
Beitrag kommentieren
Bereiche: posts:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts/{id}/comments"POST /posts/{id}/pin
POST/posts/{id}/pin
Beitrag anheften
Bereiche: posts:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/posts/{id}/pin"GET /organizations/{orgId}/posts/scheduled
GET/organizations/{orgId}/posts/scheduled
Geplante Beiträge lesen
Bereiche: posts:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/posts/scheduled"DELETE /announcements/{id}
DELETE/announcements/{id}
Mitteilung löschen
Bereiche: announcements:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/announcements/{id}"GET /announcements/{id}/missing
GET/announcements/{id}/missing
Wer eine Mitteilung noch nicht gelesen hat
Bereiche: announcements:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/announcements/{id}/missing"GET /task-items/{id}
GET/task-items/{id}
Eine Aufgabe lesen
Bereiche: tasks:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}"PATCH /task-items/{id}
PATCH/task-items/{id}
Aufgabe ändern
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}"DELETE /task-items/{id}
DELETE/task-items/{id}
Aufgabe löschen
Bereiche: tasks:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}"POST /organizations/{orgId}/task-items
POST/organizations/{orgId}/task-items
Aufgabe in einer Liste anlegen
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/task-items"PUT /task-items/{id}/status
PUT/task-items/{id}/status
Aufgabenstatus setzen
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}/status"POST /task-items/{id}/claim
POST/task-items/{id}/claim
Aufgabe übernehmen
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}/claim"GET /task-items/{id}/comments
GET/task-items/{id}/comments
Kommentare einer Aufgabe lesen
Bereiche: tasks:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}/comments"POST /task-items/{id}/comments
POST/task-items/{id}/comments
Aufgabe kommentieren
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-items/{id}/comments"POST /organizations/{orgId}/task-lists
POST/organizations/{orgId}/task-lists
Aufgabenliste anlegen
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/task-lists"PATCH /task-lists/{id}
PATCH/task-lists/{id}
Aufgabenliste ändern
Bereiche: tasks:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-lists/{id}"DELETE /task-lists/{id}
DELETE/task-lists/{id}
Aufgabenliste löschen
Bereiche: tasks:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/task-lists/{id}"GET /organizations/{orgId}/task-stats
GET/organizations/{orgId}/task-stats
Aufgaben-Auswertung lesen
Bereiche: tasks:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/task-stats"GET /organizations/{orgId}/polls
GET/organizations/{orgId}/polls
Umfragen lesen
Bereiche: polls:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/polls"POST /organizations/{orgId}/polls
POST/organizations/{orgId}/polls
Umfrage anlegen
Bereiche: polls:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/polls"GET /polls/{id}
GET/polls/{id}
Eine Umfrage lesen
Bereiche: polls:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/polls/{id}"DELETE /polls/{id}
DELETE/polls/{id}
Umfrage löschen
Bereiche: polls:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/polls/{id}"PUT /polls/{id}/votes
PUT/polls/{id}/votes
An einer Umfrage abstimmen
Bereiche: polls:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/polls/{id}/votes"POST /polls/{id}/close
POST/polls/{id}/close
Umfrage beenden
Bereiche: polls:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/polls/{id}/close"GET /organizations/{orgId}/resolutions
GET/organizations/{orgId}/resolutions
Digitale Abstimmungen lesen
Bereiche: resolutions:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/resolutions"POST /organizations/{orgId}/resolutions
POST/organizations/{orgId}/resolutions
Digitale Abstimmung anlegen
Bereiche: resolutions:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/resolutions"GET /resolutions/{id}
GET/resolutions/{id}
Eine digitale Abstimmung lesen
Bereiche: resolutions:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/resolutions/{id}"PUT /resolutions/{id}/vote
PUT/resolutions/{id}/vote
Bei einer digitalen Abstimmung abstimmen
Bereiche: resolutions:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/resolutions/{id}/vote"POST /resolutions/{id}/close
POST/resolutions/{id}/close
Digitale Abstimmung abschließen
Bereiche: resolutions:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/resolutions/{id}/close"GET /organizations/{orgId}/minutes
GET/organizations/{orgId}/minutes
Protokolle lesen
Bereiche: minutes:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/minutes"POST /organizations/{orgId}/minutes
POST/organizations/{orgId}/minutes
Protokoll anlegen
Bereiche: minutes:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/minutes"GET /minutes/{id}
GET/minutes/{id}
Ein Protokoll lesen
Bereiche: minutes:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/minutes/{id}"PUT /minutes/{id}
PUT/minutes/{id}
Protokoll ändern
Bereiche: minutes:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/minutes/{id}"DELETE /minutes/{id}
DELETE/minutes/{id}
Protokoll löschen
Bereiche: minutes:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/minutes/{id}"GET /organizations/{orgId}/beschlussregister/{id}
GET/organizations/{orgId}/beschlussregister/{id}
Einen Beschluss lesen
Bereiche: decisions:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/beschlussregister/{id}"PATCH /organizations/{orgId}/beschlussregister/{id}
PATCH/organizations/{orgId}/beschlussregister/{id}
Beschluss ändern
Bereiche: decisions:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/beschlussregister/{id}"POST /organizations/{orgId}/beschlussregister
POST/organizations/{orgId}/beschlussregister
Beschluss ins Register eintragen
Bereiche: decisions:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/beschlussregister"POST /organizations/{orgId}/beschlussregister/{id}/status
POST/organizations/{orgId}/beschlussregister/{id}/status
Beschlussstand ändern (z. B. aufheben)
Bereiche: decisions:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/beschlussregister/{id}/status"GET /organizations/{orgId}/bylaws
GET/organizations/{orgId}/bylaws
Satzung lesen
Bereiche: minutes:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/bylaws"GET /organizations/{id}/members/pending
GET/organizations/{id}/members/pending
Offene Beitrittsanfragen lesen
Bereiche: members:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{id}/members/pending"POST /organizations/{id}/members/{userId}/decision
POST/organizations/{id}/members/{userId}/decision
Beitrittsanfrage annehmen oder ablehnen
Bereiche: members:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
userId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{id}/members/{userId}/decision"PATCH /organizations/{id}/members/{userId}/role
PATCH/organizations/{id}/members/{userId}/role
Rolle eines Mitglieds ändern
Bereiche: members:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
userId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{id}/members/{userId}/role"GET /organizations/{orgId}/offices
GET/organizations/{orgId}/offices
Ämter lesen
Bereiche: offices:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/offices"POST /organizations/{orgId}/offices
POST/organizations/{orgId}/offices
Amt anlegen
Bereiche: offices:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/offices"PUT /organizations/{orgId}/offices/{officeId}
PUT/organizations/{orgId}/offices/{officeId}
Amt ändern
Bereiche: offices:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
officeId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/offices/{officeId}"DELETE /organizations/{orgId}/offices/{officeId}
DELETE/organizations/{orgId}/offices/{officeId}
Amt löschen
Bereiche: offices:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
officeId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/offices/{officeId}"POST /organizations/{orgId}/offices/{officeId}/holders
POST/organizations/{orgId}/offices/{officeId}/holders
Amtsinhaber eintragen
Bereiche: offices:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
officeId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/offices/{officeId}/holders"DELETE /organizations/{orgId}/office-holdings/{holdingId}
DELETE/organizations/{orgId}/office-holdings/{holdingId}
Amtszeit beenden
Bereiche: offices:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
holdingId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/office-holdings/{holdingId}"GET /organizations/{orgId}/roles
GET/organizations/{orgId}/roles
Rollen lesen
Bereiche: offices:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/roles"GET /organizations/{orgId}/officers
GET/organizations/{orgId}/officers
Vorstand und Leitung lesen
Bereiche: offices:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/officers"GET /organizations/{orgId}/karteimitglieder
GET/organizations/{orgId}/karteimitglieder
Karteimitglieder lesen
Bereiche: kartei:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/karteimitglieder"POST /organizations/{orgId}/karteimitglieder
POST/organizations/{orgId}/karteimitglieder
Karteimitglied anlegen
Bereiche: kartei:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/karteimitglieder"GET /organizations/{orgId}/karteimitglieder/{id}
GET/organizations/{orgId}/karteimitglieder/{id}
Ein Karteimitglied lesen
Bereiche: kartei:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/karteimitglieder/{id}"PATCH /organizations/{orgId}/karteimitglieder/{id}
PATCH/organizations/{orgId}/karteimitglieder/{id}
Karteimitglied ändern
Bereiche: kartei:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/karteimitglieder/{id}"DELETE /organizations/{orgId}/karteimitglieder/{id}
DELETE/organizations/{orgId}/karteimitglieder/{id}
Karteimitglied entfernen
Bereiche: kartei:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/karteimitglieder/{id}"GET /organizations/{orgId}/karteimitglieder/geburtstage
GET/organizations/{orgId}/karteimitglieder/geburtstage
Geburtstage der Karteimitglieder lesen
Bereiche: kartei:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/karteimitglieder/geburtstage"GET /organizations/{orgId}/documents
GET/organizations/{orgId}/documents
Dokumente lesen
Bereiche: documents:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/documents"POST /organizations/{orgId}/documents
POST/organizations/{orgId}/documents
Dokument anlegen
Bereiche: documents:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/documents"PATCH /documents/{id}
PATCH/documents/{id}
Dokument ändern
Bereiche: documents:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/documents/{id}"DELETE /documents/{id}
DELETE/documents/{id}
Dokument löschen
Bereiche: documents:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/documents/{id}"GET /organizations/{orgId}/ablage
GET/organizations/{orgId}/ablage
Dateiablage lesen
Bereiche: files:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage"GET /organizations/{orgId}/ablage/search
GET/organizations/{orgId}/ablage/search
Dateiablage durchsuchen
Bereiche: files:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/search"POST /organizations/{orgId}/ablage/folders
POST/organizations/{orgId}/ablage/folders
Ordner anlegen
Bereiche: files:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/folders"PATCH /organizations/{orgId}/ablage/folders/{id}
PATCH/organizations/{orgId}/ablage/folders/{id}
Ordner umbenennen
Bereiche: files:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/folders/{id}"DELETE /organizations/{orgId}/ablage/folders/{id}
DELETE/organizations/{orgId}/ablage/folders/{id}
Ordner in den Papierkorb legen
Bereiche: files:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/folders/{id}"PATCH /organizations/{orgId}/ablage/files/{id}
PATCH/organizations/{orgId}/ablage/files/{id}
Datei umbenennen
Bereiche: files:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/files/{id}"DELETE /organizations/{orgId}/ablage/files/{id}
DELETE/organizations/{orgId}/ablage/files/{id}
Datei in den Papierkorb legen
Bereiche: files:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/files/{id}"GET /organizations/{orgId}/ablage/trash
GET/organizations/{orgId}/ablage/trash
Papierkorb der Ablage lesen
Bereiche: files:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/trash"POST /organizations/{orgId}/ablage/trash/files/{id}/restore
POST/organizations/{orgId}/ablage/trash/files/{id}/restore
Datei aus dem Papierkorb wiederherstellen
Bereiche: files:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/trash/files/{id}/restore"POST /organizations/{orgId}/ablage/trash/folders/{id}/restore
POST/organizations/{orgId}/ablage/trash/folders/{id}/restore
Ordner aus dem Papierkorb wiederherstellen
Bereiche: files:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ablage/trash/folders/{id}/restore"GET /organizations/{orgId}/chronicle
GET/organizations/{orgId}/chronicle
Vereinschronik lesen
Bereiche: chronicle:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/chronicle"POST /organizations/{orgId}/chronicle
POST/organizations/{orgId}/chronicle
Chronikeintrag anlegen
Bereiche: chronicle:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/chronicle"DELETE /chronicle/{id}
DELETE/chronicle/{id}
Chronikeintrag löschen
Bereiche: chronicle:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/chronicle/{id}"GET /organizations/{orgId}/honors
GET/organizations/{orgId}/honors
Ehrungen lesen
Bereiche: awards:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/honors"POST /organizations/{orgId}/honors
POST/organizations/{orgId}/honors
Ehrung eintragen
Bereiche: awards:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/honors"DELETE /honors/{id}
DELETE/honors/{id}
Ehrung löschen
Bereiche: awards:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/honors/{id}"GET /organizations/{orgId}/auszeichnungen/arten
GET/organizations/{orgId}/auszeichnungen/arten
Auszeichnungsarten lesen
Bereiche: awards:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/auszeichnungen/arten"POST /organizations/{orgId}/auszeichnungen/arten/{artId}/vergaben
POST/organizations/{orgId}/auszeichnungen/arten/{artId}/vergaben
Auszeichnung vergeben
Bereiche: awards:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
artId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/auszeichnungen/arten/{artId}/vergaben"DELETE /organizations/{orgId}/auszeichnungen/vergaben/{id}
DELETE/organizations/{orgId}/auszeichnungen/vergaben/{id}
Auszeichnungsvergabe zurücknehmen
Bereiche: awards:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/auszeichnungen/vergaben/{id}"GET /organizations/{orgId}/inventory
GET/organizations/{orgId}/inventory
Inventar lesen
Bereiche: inventory:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/inventory"POST /organizations/{orgId}/inventory
POST/organizations/{orgId}/inventory
Inventar anlegen
Bereiche: inventory:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/inventory"DELETE /inventory/{id}
DELETE/inventory/{id}
Inventar löschen
Bereiche: inventory:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/inventory/{id}"GET /organizations/{orgId}/shifts
GET/organizations/{orgId}/shifts
Dienste lesen
Bereiche: shifts:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/shifts"POST /organizations/{orgId}/shifts
POST/organizations/{orgId}/shifts
Dienst anlegen
Bereiche: shifts:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/shifts"POST /shifts/{id}/signup
POST/shifts/{id}/signup
Für einen Dienst eintragen
Bereiche: shifts:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/shifts/{id}/signup"DELETE /shifts/{id}/signup
DELETE/shifts/{id}/signup
Aus einem Dienst austragen
Bereiche: shifts:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/shifts/{id}/signup"DELETE /shifts/{id}
DELETE/shifts/{id}
Dienst löschen
Bereiche: shifts:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/shifts/{id}"GET /organizations/{orgId}/albums
GET/organizations/{orgId}/albums
Fotoalben lesen
Bereiche: albums:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/albums"POST /organizations/{orgId}/albums
POST/organizations/{orgId}/albums
Fotoalbum anlegen
Bereiche: albums:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/albums"DELETE /albums/{id}
DELETE/albums/{id}
Fotoalbum löschen
Bereiche: albums:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/albums/{id}"GET /organizations/{orgId}/matches
GET/organizations/{orgId}/matches
Spiele und Ergebnisse lesen
Bereiche: matches:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/matches"POST /organizations/{orgId}/matches
POST/organizations/{orgId}/matches
Spiel eintragen
Bereiche: matches:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/matches"PATCH /organizations/{orgId}/matches/{matchId}
PATCH/organizations/{orgId}/matches/{matchId}
Spiel ändern
Bereiche: matches:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
matchId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/matches/{matchId}"DELETE /organizations/{orgId}/matches/{matchId}
DELETE/organizations/{orgId}/matches/{matchId}
Spiel löschen
Bereiche: matches:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
matchId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/matches/{matchId}"GET /organizations/{orgId}/dues
GET/organizations/{orgId}/dues
Beitragsforderungen lesen
Bereiche: finance:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/dues"POST /organizations/{orgId}/dues
POST/organizations/{orgId}/dues
Beitragsforderung anlegen
Bereiche: finance:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/dues"PUT /dues/{id}/status
PUT/dues/{id}/status
Beitragsstatus vermerken (z. B. bezahlt)
Bereiche: finance:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/dues/{id}/status"DELETE /dues/{id}
DELETE/dues/{id}
Beitragsforderung löschen
Bereiche: finance:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/dues/{id}"GET /organizations/{orgId}/finance/overview
GET/organizations/{orgId}/finance/overview
Finanzübersicht lesen
Bereiche: finance:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/finance/overview"GET /organizations/{orgId}/ledger
GET/organizations/{orgId}/ledger
Buchungsjournal lesen
Bereiche: finance:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/ledger"GET /organizations/{orgId}/donations
GET/organizations/{orgId}/donations
Spendenaufrufe lesen
Bereiche: donations:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/donations"POST /organizations/{orgId}/donations
POST/organizations/{orgId}/donations
Spendenaufruf anlegen
Bereiche: donations:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/donations"PATCH /donations/{id}
PATCH/donations/{id}
Spendenaufruf ändern
Bereiche: donations:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/donations/{id}"DELETE /donations/{id}
DELETE/donations/{id}
Spendenaufruf löschen
Bereiche: donations:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/donations/{id}"POST /donations/{id}/close
POST/donations/{id}/close
Spendenaufruf beenden
Bereiche: donations:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/donations/{id}/close"GET /organizations/{orgId}/foerderung/projekte
GET/organizations/{orgId}/foerderung/projekte
Förderprojekte lesen
Bereiche: grants:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/foerderung/projekte"POST /organizations/{orgId}/foerderung/projekte
POST/organizations/{orgId}/foerderung/projekte
Förderprojekt anlegen
Bereiche: grants:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/foerderung/projekte"GET /organizations/{orgId}/foerderung/projekte/{id}
GET/organizations/{orgId}/foerderung/projekte/{id}
Ein Förderprojekt lesen
Bereiche: grants:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/foerderung/projekte/{id}"PATCH /organizations/{orgId}/foerderung/projekte/{id}
PATCH/organizations/{orgId}/foerderung/projekte/{id}
Förderprojekt ändern
Bereiche: grants:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/foerderung/projekte/{id}"DELETE /organizations/{orgId}/foerderung/projekte/{id}
DELETE/organizations/{orgId}/foerderung/projekte/{id}
Förderprojekt löschen
Bereiche: grants:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/foerderung/projekte/{id}"GET /organizations/{orgId}/foerderung/pflichttermine
GET/organizations/{orgId}/foerderung/pflichttermine
Fristen der Förderung lesen
Bereiche: grants:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/foerderung/pflichttermine"GET /organizations/{orgId}/stellen
GET/organizations/{orgId}/stellen
Stellen und Gesuche lesen
Bereiche: jobs:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/stellen"POST /organizations/{orgId}/stellen
POST/organizations/{orgId}/stellen
Stelle oder Gesuch anlegen
Bereiche: jobs:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/stellen"GET /organizations/{orgId}/stellen/{id}
GET/organizations/{orgId}/stellen/{id}
Eine Stelle lesen
Bereiche: jobs:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/stellen/{id}"PATCH /organizations/{orgId}/stellen/{id}
PATCH/organizations/{orgId}/stellen/{id}
Stelle ändern
Bereiche: jobs:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/stellen/{id}"DELETE /organizations/{orgId}/stellen/{id}
DELETE/organizations/{orgId}/stellen/{id}
Stelle löschen
Bereiche: jobs:deletePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/stellen/{id}"POST /organizations/{orgId}/stellen/{id}/status
POST/organizations/{orgId}/stellen/{id}/status
Stelle veröffentlichen oder schließen
Bereiche: jobs:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/stellen/{id}/status"GET /organizations/{organizationId}/terminfindungen
GET/organizations/{organizationId}/terminfindungen
Terminfindungen der Organisation lesen
Bereiche: planner:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
organizationId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{organizationId}/terminfindungen"POST /organizations/{organizationId}/terminfindungen
POST/organizations/{organizationId}/terminfindungen
Terminfindung anlegen
Bereiche: planner:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
organizationId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{organizationId}/terminfindungen"GET /organizations/{orgId}/engagement/uebersicht
GET/organizations/{orgId}/engagement/uebersicht
Engagement-Übersicht lesen
Bereiche: engagement:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/engagement/uebersicht"GET /organizations/{orgId}/engagement/punkte/regeln
GET/organizations/{orgId}/engagement/punkte/regeln
Punkteregeln lesen
Bereiche: engagement:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/engagement/punkte/regeln"GET /organizations/{orgId}/engagement/punkte/buchungen
GET/organizations/{orgId}/engagement/punkte/buchungen
Punktebuchungen lesen
Bereiche: engagement:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/engagement/punkte/buchungen"POST /organizations/{orgId}/engagement/punkte/buchungen
POST/organizations/{orgId}/engagement/punkte/buchungen
Punkte manuell buchen
Bereiche: engagement:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/engagement/punkte/buchungen"POST /organizations/{orgId}/engagement/punkte/buchungen/{id}/storno
POST/organizations/{orgId}/engagement/punkte/buchungen/{id}/storno
Punktebuchung stornieren
Bereiche: engagement:writePremium (Organisationsschlüssel)
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
orgId | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
id | Pfad | ja | Kennung (UUID) bzw. Pfadteil laut Route |
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -X POST -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/organizations/{orgId}/engagement/punkte/buchungen/{id}/storno"GET /newskanal/mein
GET/newskanal/mein
Eigenen Newskanal lesen
Bereiche: newskanal:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/newskanal/mein"GET /newskanal/mein/beitraege
GET/newskanal/mein/beitraege
Eigene Newskanal-Beiträge lesen
Bereiche: newskanal:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/newskanal/mein/beitraege"GET /newskanal/feed
GET/newskanal/feed
Newsfeed der abonnierten Kanäle lesen
Bereiche: newskanal:read
Die Rechte der Person hinter dem Schlüssel gelten unverändert; fremde oder nicht sichtbare Organisationen antworten 404.
| Status | Bedeutung |
|---|---|
| 200 | Erfolg |
| 400 | Eingabe ungültig (VALIDATION_FAILED) oder Löschbestätigung fehlt (CONFIRMATION_REQUIRED) |
| 401 | Schlüssel ungültig, abgelaufen, widerrufen oder Adresse nicht erlaubt (INVALID_API_KEY) |
| 403 | Bereich fehlt (INSUFFICIENT_SCOPE), Recht fehlt (FORBIDDEN), Organisationsschlüssel nötig (ORGANIZATION_KEY_REQUIRED) oder Premium nötig (PREMIUM_REQUIRED) |
| 404 | Nicht gefunden — auch für Ressourcen anderer Organisationen |
| 429 | Zu viele Anfragen (RATE_LIMITED) |
curl -H "Authorization: Bearer clup_k_…" \
"https://api.clup.life/api/v1/newskanal/feed"