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. Make sure "https://api.kickbase.com - Kickbase v4" is selected in the "Servers" dropdown

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

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

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

   {
     "em": "your-kickbase-email",
     "loy": false,
     "pass": "your-kickbase-password",
     "rep": {}
   }

5. Click the "Execute" button and copy the property "tkn" from the response body json

   {
       ...
       "tkn": "my-secret-access-token",
       ...
   }

6. Click "Authorize" at the top right corner of the page, paste in the access token into the value field and click again "Authorize"

7. 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

simonsagstetter

casudo

Issues

As all of the endpoints are found by try and error, this documentation may be incomplete. Most likely there are more endpoints. In fact, most of the post, put or delete requests have missing request bodies. If you have any further information about new or existing endpoints feel free to submit them in the issues. We'll review and add them to the documentation.

Thank you!

License

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