Small Improvements REST API

Small Improvements is (mostly) a Single-Page-Application based on a REST API. We are not promoting the REST API for external use yet because the API is still evolving, and documented only for internal usecases. Our main use-case for now is our own JavaScript-client. Please do talk to us before you build something large and complex on the API.

To access the API you either need to log in using our login user interface, or you can log in using OAuth. Once logged in, you can access the API at /api/v2

You can find our Swagger-based API documentation here. It's not a proper annotated documentation though, and you'll need to poke around by yourself.

Please note:

  • The API is evolving based on our SPA needs, and some end-user screens like those for 360 feedback and performance reviews are not yet covered.
  • Please don't build substantial product extensions based on the API. While we try to keep change small and predictable, things do change without notice sometimes
  • In some cases (e.g. for billing contacts) an ID has to be provided. This is typically your company ID, which you can find on the Security page
  • Remember, all URLs need to get prefixed by /api/v2

In many cases it may help to navigate to the SI screen that already deals with functionality you're interested in, and analyze the network tab in your browser to get a deeper understanding of how to call the API.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us