Build automated workflows and dynamic integrations across your entire employee lifecycle
The Kallidus Suite
The Kallidus suite comprises of multiple self-integrated products, namely:
- Learn - a learning management system
- Perform - a performance management system
- Recruit - an applicant tracking system
- Sapling - an HR information system
This API documentation covers the Kallidus Sapling API.
Methods
Kallidus provides RESTful APIs utilizing standard HTTPS methods (GET, POST, PUT, DELETE), and JSON-formatted and TLS-encrypted requests and responses.
All our APIs have restricted access (see Authentication).
Rate Limits
Kallidus does not currently enforce specific rate limits across any of its APIs, but we do apply dynamic IP throttling to ensure fair usage across our customers. We reserve the right to limit or block any unfair usage of our APIs.
As best practice, we advise that you do not exceed 100 requests per minute per API key. Alternatively, you can employ event-driven requests to reduce excessive volumes (see Webhooks).
Authentication
When calling this API, you request must include a bearer token authorization in the header. To generate an bearer token (called an API key within Sapling), follow these steps.
Routing
For US-hosted customers (saplingapp.io domain), your API requests should point to: https://{{subdomain}}.saplingapp.io/api/v1/beta/{{resource}}
For UK-hosted customers (kallidus-suite.com domain), your API requests should point to: https://{{subdomain}}.kallidus-suite.com/hr/api/v1/beta/{{resource}}
Responses
| Code | Meaning |
|---|---|
| 200 | Status OK – Request processed without issues |
| 201 | Created |
| 204 | No content - Successful request without body content |
| 401 | Unauthorized – Could not authenticate using provided API key |
| 403 | Forbidden – You do not have permission to view the requested resource |
| 404 | Not found – Resource could not be found |
| 405 | Method not allowed |
| 429 | Too many requests have been sent in a given amount of time - rate limit has been reached |
| 500 | Internal server error |
| 503 | Service unavailable |
Webhooks
To subscribe to Sapling webhooks, follow these steps.