Developers API reference

API reference

All routes of the CLUP.life REST API v1 with parameters, responses and examples — generated from the OpenAPI description. Download as JSON and YAML.

This reference is generated from the real OpenAPI description; it cannot drift from the API. A development test fails as soon as a route is missing or the description no longer matches the documentation.

OpenAPI as JSON OpenAPI as YAML

Base URL: https://api.clup.life/api/v1 · OpenAPI 3.1.0 · Version 1.0.0

GET/ext/me

Who am I? Account, scopes of the key, memberships

Areas: profile:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/me"

GET/ext/directory/organizations

Search the club directory (public organizations only)

Areas: directory:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`cursor`	Query	off	Continuation from nextCursor of the previous response (no page numbers, no OFFSET)
`limit`	Query	off	1–100, default 30
`q`	Query	off	Search term (display name; in the directory: name, short name or place)
`categories`	Query	off	Topics, separated with \|
`types`	Query	off	CLUB, ASSOCIATION, GROUP, MUNICIPALITY (comma-separated)
`state`	Query	off	Federal state as a code, e.g. DE-RP (comma-separated)
`place`	Query	off	Town or postal code
`radiusKm`	Query	off	Radius 1–300 (with place)
`ageFrom`	Query	off	Offer for ages from
`ageTo`	Query	off	Offer for ages up to
`membersMin`	Query	off	Minimum number of members
`membersMax`	Query	off	Maximum number of members
`foundedFrom`	Query	off	Founded from (year)
`foundedTo`	Query	off	Founded up to (year)
`accepting`	Query	off	1 = accepts new members
`sort`	Query	off	relevance, distance, name, size or new

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/directory/organizations"

GET/ext/events

Events in a period

Areas: events:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`from`	Query	on	Start of the period (ISO 8601, e.g. 2026-11-01T00:00:00Z)
`to`	Query	on	End of the period (at most 400 days after from)
`organization`	Query	off	Only events of this organization (slug)

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Create an event

Areas: events:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization

{
  "title": "Sommerfest",
  "startsAt": "2026-07-04T14:00:00Z",
  "endsAt": "2026-07-04T20:00:00Z",
  "visibility": "MEMBERS"
}

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Member list (only if the person’s role shows it)

Areas: members:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization
`cursor`	Query	off	Continuation from nextCursor of the previous response (no page numbers, no OFFSET)
`limit`	Query	off	1–100, default 30
`q`	Query	off	Search term (display name; in the directory: name, short name or place)

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/organizations/mein-verein/members"

GET/ext/organizations/{org}/posts

Posts

Areas: posts:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization
`cursor`	Query	off	Continuation from nextCursor of the previous response (no page numbers, no OFFSET)
`limit`	Query	off	1–100, default 30

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/organizations/mein-verein/posts"

GET/ext/organizations/{org}/announcements

Announcements

Areas: announcements:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization
`cursor`	Query	off	Continuation from nextCursor of the previous response (no page numbers, no OFFSET)
`limit`	Query	off	1–100, default 30

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/organizations/mein-verein/announcements"

POST/ext/organizations/{org}/announcements

Publish an announcement

Areas: announcements:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization

{
  "title": "Hallenzeiten ändern sich",
  "body": "Ab Montag trainieren wir in der kleinen Halle."
}

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Tasks

Areas: tasks:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization
`scope`	Query	off	open (default) or done
`cursor`	Query	off	Continuation from nextCursor of the previous response (no page numbers, no OFFSET)
`limit`	Query	off	1–100, default 30

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/organizations/mein-verein/tasks"

POST/ext/organizations/{org}/tasks

Create a task

Areas: tasks:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization

{
  "title": "Zelte prüfen",
  "dueDate": "2026-06-20"
}

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -X POST -H "Authorization: Bearer clup_k_…" \
  -H "Content-Type: application/json" \
  -d '{"title":"Zelte prüfen","dueDate":"2026-06-20"}' \
  "https://api.clup.life/api/v1/ext/organizations/mein-verein/tasks"

GET/ext/presse/posts

Published press releases and news

Areas: presse:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`art`	Query	off	PRESS_RELEASE or NEWS
`lang`	Query	off	Language code, e.g. de, en (falls back to German)
`cursor`	Query	off	Continuation from nextCursor of the previous response (no page numbers, no OFFSET)
`limit`	Query	off	1–100, default 30

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/presse/posts"

POST/ext/presse/posts

Create a press release or news item as a draft

Areas: presse:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

{
  "kind": "NEWS",
  "slug": "neue-funktion",
  "texts": [
    {
      "locale": "de",
      "title": "Neue Funktion",
      "summary": "Kurzer Anreißer der Meldung.",
      "body": "Text in einfachem Markdown."
    }
  ]
}

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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}

One post by slug (with presse:write also by id, including drafts)

Areas: presse:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`ref`	Path	on	Slug or identifier of the post
`lang`	Query	off	Language code, e.g. de, en (falls back to German)

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/presse/posts/{ref}"

PUT/ext/presse/posts/{id}

Change a post

Areas: presse:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`id`	Path	on	Identifier of the post

{
  "kind": "NEWS",
  "slug": "neue-funktion",
  "texts": [
    {
      "locale": "de",
      "title": "Neue Funktion",
      "summary": "Kurzer Anreißer der Meldung.",
      "body": "Geänderter Text."
    }
  ]
}

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Publish a post now

Areas: presse:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`id`	Path	on	Identifier of the post

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Schedule publication

Areas: presse:writePremium (organization key)

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`id`	Path	on	Identifier of the post

{
  "publishAt": "2026-11-01T08:00:00Z"
}

Status	Meaning
200	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Events as iCal

Areas: exports:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`from`	Query	on	Start of the period (ISO 8601, e.g. 2026-11-01T00:00:00Z)
`to`	Query	on	End of the period (at most 400 days after from)
`organization`	Query	off	Only events of this organization (slug)

Status	Meaning
200 (text/calendar)	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Events as CSV

Areas: exports:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`from`	Query	on	Start of the period (ISO 8601, e.g. 2026-11-01T00:00:00Z)
`to`	Query	on	End of the period (at most 400 days after from)
`organization`	Query	off	Only events of this organization (slug)

Status	Meaning
200 (text/csv)	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

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

Member list as CSV (leadership only, logged)

Areas: exports:read, members:read

The rights of the person behind the key apply unchanged; foreign or invisible organizations answer 404.

Name	Location	Obligation	Description
`org`	Path	on	Identifier (slug) of the organization

Status	Meaning
200 (text/csv)	Success
401	Key invalid, expired or revoked (INVALID_API_KEY)
403	Scope missing (INSUFFICIENT_SCOPE), right missing (FORBIDDEN) or Premium required (PREMIUM_REQUIRED)
404	Not found — also for organizations the key may not see
429	Too many requests (RATE_LIMITED); respect Retry-After

curl -H "Authorization: Bearer clup_k_…" \
  "https://api.clup.life/api/v1/ext/exports/organizations/mein-verein/members.csv"

GET /ext/me

GET /ext/directory/organizations

GET /ext/events

POST /ext/organizations/{org}/events

GET /ext/organizations/{org}/members

GET /ext/organizations/{org}/posts

GET /ext/organizations/{org}/announcements

POST /ext/organizations/{org}/announcements

GET /ext/organizations/{org}/tasks

POST /ext/organizations/{org}/tasks

GET /ext/presse/posts

POST /ext/presse/posts

GET /ext/presse/posts/{ref}

PUT /ext/presse/posts/{id}

POST /ext/presse/posts/{id}/publish

POST /ext/presse/posts/{id}/schedule

GET /ext/exports/events.ics

GET /ext/exports/events.csv

GET /ext/exports/organizations/{org}/members.csv