API Documentation
Introduction
API Documentation
Introduction
Before using our API endpoints
Base URL
The base url of the public api is https://api.siit.io. The API is versionned but any route / param is subject to change while we’re still on V0 (beta).
A note about Resources
Our API uses prefixed UIDs to identify the type of resources we’re working with. Here is a non-exhaustive list of resources you might encounter and their corresponding UID format:
| Resource | UID Format | Additional note |
|---|---|---|
| Request | req_xxx | (or REQxxx for legacy objects) |
| User | u_xxx | (or Uxxx for legacy object) |
| Application | s_xxx | (or Sxxx for legacy object) |
| Service | wa_xxx | (or WAxxx for legacy object) |
| Tag | tv_xxx | (or TVxxx for legacy object) |
| Workflow | wfe_xxx | (or WFExxx for legacy object) |
Rate limiting
Please note that requests are limited to 60 requests / minutes. Contact us if you need higher quota.
Queries made to our API will return custom headers:
| Header | Description |
|---|---|
X-SiitApi-Limit | The number of requests allowed / period |
X-SiitApi-Remaining | How many requests remain for the current period |
X-SiitApi-Reset | This header is only returned on when you have been rate-limited and represents the timestamp at which you can start querying again |