Let's get you up and running with our API!
This guide assumes you already have a Kombo account. If that's not the case, visit our website to learn more and get access.
Adding your first integration
- Log in to the Kombo Dashboard
- Go to the "Integrations" page
- Click "New integration":
- Select "Create the integration yourself":
- Work your way through the flow and enter the necessary credentials
Your first integration ID
After going through the connection flow, your newly created integration will appear on your dashboard. It will probably look something like this:
Note the bold string at the top starting with the name of the tool you've connected (
factorial in this example): that's the integration ID. It uniquely identifies this integration, and you'll include it in all related API requests.
Using the unified API
Now that you've created an integration, it's time to get to the most crucial part: Actually calling the Kombo API to retrieve data from the integration.
Thanks to our interactive API documentation, you'll be able to do this right from your browser. To get started, head over to our API reference and choose an endpoint from the category of your integration (e.g., HRIS or ATS).
Calling the endpoint
Let's say we want to retrieve all the employees in Factorial (the HRIS system I connected for this example). To do this, I'll have to call the
Configuring the headers
Before we can send off the request, there are two things we have to configure:
First, we have to set our Kombo API key, which ensures that only you can request data from your customers' integrations. Enter it in the "Authentication" field in the top right:
You've likely got a single integration set up at this point, but you'll probably have many in the future. That's why you have to specify which integration you're requesting data for with each request. This can be done through the
X-Integration-Id header, which you can find at the bottom of the page:
As you can see, I've already entered the integration of the Factorial integration I've created above. Now everything is ready to send the request: Scroll back up and Try it!
You should now see a list of employees (or whatever the endpoint you chose returns), congratulations!
Programmatically calling the API
Calling the Kombo API through the documentation site works great for experimenting, but you'll likely want to integrate Kombo into your own application. In the future, we'll be providing official SDKs for this purpose, but for now, you can use our docs to generate code snippets.
To do this, select your programming language in the top right. You'll then be provided with the code you need to make the same API call you made interactively:
In this guide, we've:
- created a new integration through the Kombo dashboard
- learned about integration IDs and Kombo's authentication
- made a request to the Kombo API through the interactive docs
- generated code to interact with the Kombo API programmatically
You're now ready to continue on your own. Go build great things! ✨
Updated 5 months ago
If you haven't yet, check out our API reference for all available models and endpoints.