Important:
Small Improvements is a single-page application based on a REST API. While all data can be pulled from the API, we strongly discourage the use of our API unless you’re a product company wanting to build an integration or have a team of senior developers at your disposal.
Is using the API for me?
Our REST API is available for customers with advanced technical resources. It's best suited for experienced developers who are comfortable exploring and building independently.
Because the API is intentionally lightweight and not actively supported by our team, we ask that any customer planning to use it share a brief implementation spec before moving forward. This helps us:
Understand how you're planning to use the API
Flag any potential risks or limitations
Ensure the API is the right fit for your goals
🔧 We do not offer setup support or detailed troubleshooting. The API is provided as-is for teams with strong internal technical capabilities.
Step 1: Review API documentation and scope your project
The documentation is deliberately slim. You’ll find an overview of the Swagger-based docs here, but we don’t provide an in-depth tutorial. We expect that an experienced API developer will find their way around, and analyzing the network tab in the browser will provide extra cues. An inexperienced developer will struggle, though, and we’d discourage you from getting started if you don’t have senior developers committed to your project.
Note:
The API is evolving based on our SPA needs, and some end-user screens, such as 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 changes small and predictable, they do happen without notice.
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 be prefixed by /api/v2.
In many cases, it may help to navigate to the screen within Small Improvements that already deals with the functionality you’re interested in and analyze the network tab in your browser to get a deeper understanding of how to call the API.
Step 2: Submit your project spec form
Please fill out this form to request that the API be activated for your account. Once submitted, we'll review it to make sure what you're planning to do is supported by our API. You should hear back from us within 7-10 business days.
Step 3: API is enabled, now authenticate with your personal access token
When the API is enabled, your employees will find their personal access tokens on their profile page, under the Manage menu:
You’ll be able to create multiple tokens for any apps you want to integrate. When you create the token, you’ll only see it displayed once, so copy it right away!
You can revoke tokens individually or revoke all tokens at once.
Once you have an access token, you can make requests to the API by specifying the Authorization header.
Example Request
curl -H 'Authorization: Bearer ACCESS_TOKEN' https://app.small-improvements.com/api/v2/users/me -I
should respond with
HTTP/1.1 200 OK