Skip to content

kevinskyba/kickbase-api-doc

Repository files navigation

Kickbase API v4 Documentation

This repository contains the API v4 documentation of the popular game kickbase. This work is unofficial and not related to kickbase in any way. All of this was done for scientific reasons only and you should not use it for anything else but for your personal learning!

Usage

Web

NEW! Directly use the browseable and interactive Apidog Web Version

Use the browseable Web Version made with Apidog and Swagger Hub

How to get started:

  1. Choose endpoint /v4/user/login from the User section

  2. On the right hand side click the "Try it out" button

  3. Fill in your kickbase email and password into the request body json

    {
      "em": "your-kickbase-email",
      "loy": false,
      "pass": "your-kickbase-password",
      "rep": {}
    }
  4. Click the "Execute" button and copy the property "tkn" from the response body json

    {
        ...
        "tkn": "my-secret-access-token",
        ...
    }
  5. Click "Authorize" at the top right corner of the page, paste in the access token into the value field and click again "Authorize"

  6. Now you can try out any endpoint with your path and query params

Local

Postman

Import the Postman Collection JSON and Postman Eniroment JSON into your postman workspace

Swagger

Import the Swagger JSON into your swagger hub

Contributors

kevinskyba
kevinskyba
simonsagstetter
simonsagstetter
casudo
casudo

Issues

API Documentation Status

This documentation contains all currently known endpoints, including their path parameters, query parameters, and request bodies, as of March 6, 2026.

For GET requests, we provide response examples for most endpoints. However, for the majority of POST, PUT, and DELETE requests, response examples are currently missing. Collecting and validating these responses requires significant setup and time, and this project is maintained as a hobby project.

Descriptions have been added to most relevant endpoints. These descriptions were generated using Postman Generative AI. While they appear largely accurate at first glance, they may still contain inaccuracies or hallucinations, so please verify them before relying on them in production environments.

Please use the API responsibly. Avoid sending large numbers of requests or requesting excessive amounts of data at once. It is possible that the service provider may monitor requests made outside their official applications and block access. We do not take responsibility for any actions taken using this documentation.

If you encounter incorrect documentation or non-working endpoints, please open an issue.

Contributing

We are always looking for contributors.

At the moment, the most valuable contributions would be:

  • Collecting 2xx and 4xx responses
  • Documenting response schemas
  • Completing request body schemas

Having complete request and response schemas would allow us to generate an OpenAPI specification. This would enable automatic generation of REST clients, for example:

  • JavaScript clients using tools like Orval
  • Python clients using frameworks such as FastAPI

These improvements would significantly increase the usability of this project.

Thank you!

License

This project is licensed under the MIT License - see the LICENSE file for details

About

A documentation of the kickbase API for scientific reasons only!

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors