The Sapling API provides access to your people ops data so you can do more with custom applications and workflows
The People Ops Platform
Kallidus Sapling is the People Operations Platform that automates workflows from onboarding to offboarding to support global, distributed, and rapidly scaling companies.
By creating a connected employee experience, Sapling is the platform of choice for forward-thinking HR teams at companies like Invision, Warby Parker, Figma, PagerDuty, and Webflow.
Public API
Our public API allows you to access your people ops data to build custom applications and workflows that interact with Sapling in more complex ways than the integrations we provide out of the box.
The API provides a RESTful interface with JSON-formatted responses to access Sapling resources. We are continuously working on expanding our API functionality. However, there are (and always will be) limits to the API.
Authentication
Sapling provides RESTful APIs with restricted access. To get started, you will need to set up a Sapling API Key from your Sapling Admin Settings.
Learn how to generate an API Key here
Routing
Endpoint routing is slightly different if accessing resources for customers hosted in our US data centers vs our UK data centers.
For customers hosted in the US, the route pattern is:
https://{{subdomain}}.saplingapp.io/api/v1/beta/{{resource}}
For customers hosted in the UK, the route pattern is:
https://{{subdomain}}.kallidus-suite.com/hr/api/v1/beta/{{resource}}
Encryption
All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons.
Rate Limits
The Sapling API does not currently enforce a specific rate limit across any of its endpoints. However, to ensure fair use of our products we do reserve the right to block or throttle your requests in the future. For the most optimal use of the API, we strongly recommend implementing event-driven requests by leveraging our highly configurable webhooks.
Pagination
All resources with a list endpoint (pending hires, users, fields, tasks) have pagination support. By default, the limit is set to 50 results.
To crawl multiple pages, you must query by the page parameter (page=n).
Responses
Responses use the customary HTTP status codes.
| Code | Meaning |
|---|---|
| 200 | Status OK – Request processed without issues |
| 201 | Created |
| 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 |
How to get Started
The documentation uses {{subdomain}} for example requests, which should be replaced with your company's subdomain of your Sapling account (for example, rocketship).
If you're looking to integrate with Sapling and you'd like access to a developer sandbox, please fill out this request form - you'll need to be working on behalf of a mutual customer at this time. Once submitted, we'll follow up with you within 3 business days.
Feedback
The Sapling team greatly appreciates your feedback as we expand the methods and resources available.
Get in touch with our Team [email protected]