Authentication

You need to get an API key from the Kombo dashboard to call our API. You can create one on the Secrets page.

You might have multiple environments in your Kombo account. Each API key is specific to an environment.

This will allow you to call some general endpoints that are not integration-specific. For example, try calling the following test API key endpoint:

curl --request GET \
  --url https://api.kombo.dev/v1/check-api-key \
  --header 'Authorization: Bearer <YOUR_API_KEY>'

Calling Integration Endpoints

To call integration-specific endpoints, you need the integration ID. An integration ID identifies a specific instance of a tool connected to Kombo. If you haven’t created an integration yet, read the creating integrations guide. Get the integration ID from the details of integration on the integrations dashboard page.

Pass the integration ID with the X-Integration-Id header in your API requests. For example:

curl --request GET \
  --url http://api.kombo.dev/v1/hris/employees \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  --header 'X-Integration-Id: <integration_id>'

Find out more about the integration-specific endpoints for HRIS or ATS