Build on Klubraum
The Klubraum REST API lets your own scripts, websites and tools work with the data of a club. Plain JSON over HTTPS, one versioned base path, and an OpenAPI document you can generate a client from.
What you can do
- Read your member list, invite people by e-mail and remove members.
- Work with calendar events and their occurrences, areas and area groups, roles, conversations and messages, and surveys and polls.
- Ask a token what it is — its owner, club, scopes, plan and expiry.
The member list, invitations and removals are included in Plus. Every other endpoint needs Pro.
Authentication
Requests carry a personal access token as a bearer token. You create one in the Klubraum app: it belongs to a single club, carries only the scopes you pick, expires, and can be revoked at any time — so a token can never do more than the person who made it.
The reference
Every operation, with request and response schemas and copy-paste examples — plus a console that sends real requests.
The console is not a sandbox. It sends real requests to api.klubraum.com using the token you paste. Anything you create, change or cancel happens in your live Klubraum. Give the token only the scopes you need, and revoke it when you are done.
The OpenAPI document
The document is served live by the API, so it is never out of date. Point your own tooling straight at it:
https://api.klubraum.com/v1/openapi.json
Questions about API access? Talk to us.