This article provides an overview of the Small Improvements REST API, helping you determine if it’s the right fit for your team and outlining the steps to get up and running.
Small Improvements is a single-page application built on a REST API. While this means data can technically be accessed via the API, it is designed as a lightweight tool for teams with advanced technical resources.
Is using the API for me?
Our REST API is available to customers who have experienced developers who are comfortable exploring and building independently.
Important Note: The API is provided as-is. We do not offer setup support or detailed troubleshooting. Because the API is intentionally lightweight, we ask that you share a brief implementation spec with us before you begin. This helps us flag potential risks and ensure the API aligns with your goals.
Important considerations
Stability: The API evolves based on our application needs. While we aim for predictability, changes can occur without notice. We recommend against building substantial product extensions.
Coverage: Some end-user screens are not yet covered by the API.
Requirements: All URLs must be prefixed with
/api/v2.
How to enable and use the API
Follow these steps to scope your project and gain access to the API.
Step 1: Review the documentation and scope your project
Examine our Swagger-based documentation to understand the available endpoints. Since our documentation is limited, we strongly recommend assigning a senior developer as the project lead.
Tip: You can gain deeper insights into specific calls by navigating to the relevant screen in Small Improvements and analyzing the Network tab in your browser's developer tools.
Step 2: Submit your project spec form
Before the API can be activated for your account, you must fill out the API request form. Our team will review your implementation plan to ensure it is supported.
You can expect a response within 7-10 business days.
In some cases, you may need to provide your company ID, which is located on the Security page.
Step 3: Generate your Personal Access Token
Once the API is enabled for your account, individual employees can generate tokens.
Navigate to your Profile page.
Click the Manage menu.
Select API Access Tokens.
Click Create Token.
Note: For security reasons, your token will only be displayed once. Make sure to copy and save it immediately in a secure location.
Step 4: Authenticate your requests
Once you have your token, you can make requests by specifying the Authorization header. You can create multiple tokens for different integrations or revoke them at any time.
Example Request: curl -H 'Authorization: Bearer ACCESS_TOKEN' https://app.small-improvements.com/api/v2/users/me -I
A successful connection will return an HTTP/1.1 200 OK response.