Libraries & SDKs

Server-side SDKs

Kombo maintains and publishes multiple official server-side SDKs. These allow you to interact with the Kombo API in an ergonomic and type-safe manner, and they are the recommended way to implement Kombo if you’re on a supported tech stack. Currently, we provide the following SDKs:

@kombo-api/sdk package for TypeScript/JavaScript (GitHub, npm)
kombo package for Python (GitHub, PyPI)
kombo gem for Ruby (GitHub, RubyGems)

Using these, your server-side code may look like this:

import { Kombo } from '@kombo-api/sdk'

const kombo = new Kombo({
  api_key: process.env.KOMBO_API_KEY,
  integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
})

const result = await kombo.hris.getEmployees()

console.log(result)

from kombo import Kombo

with Kombo(
    api_key="<YOUR_BEARER_TOKEN_HERE>",
    integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
) as kombo:
    result = kombo.hris.get_employees()

    print(result)

require 'kombo'

Models = ::Kombo::Models
s = ::Kombo::Kombo.new(
  integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28',
  security: Models::Shared::Security.new(
    api_key: '<YOUR_BEARER_TOKEN_HERE>',
  ),
)

res = s.hris.get_employees()

More server-side SDKs are planned. Please don’t hesitate to reach out to us if you’re interested in an SDK for your stack!

Migrating to Kombo SDKs

Are you currently using custom code or self-built SDKs to interact with the Kombo API? It could make sense to migrate towards our official SDKs. They’re kept up to date with the latest changes to the Kombo API (including deprecated surface, which is intentionally excluded), provide you with auto-completion and detailed types for both inputs and outputs, and help you avoid common pitfalls and mistakes. If you plan to do so, you might find the following prompt useful:

LLM Prompt: Migrating to Kombo SDKs

Copy-paste this into your AI coding tool of choice (we recommend plan mode):

Prompt

Our codebase uses the Kombo Unified API for some/all integrations with third-party systems. So far, our implementation is built using custom code. We'd like to migrate to using Kombo's official SDKs.

Please help me create and then execute on a plan to perform this migration.

First, please identify all the places in our codebase where we're currently making API calls to the Kombo API (e.g., `https://api.kombo.dev/...` or `https://api.us.kombo.dev/...`).

Then, fetch the docs for the respective SDK to identify the methods to use:

- [TypeScript SDK](https://raw.githubusercontent.com/kombohq/typescript-sdk/refs/heads/main/README.md)
- [Python SDK](https://raw.githubusercontent.com/kombohq/python-sdk/refs/heads/main/README.md)

Next, create a plan for the migration. Detail which files need to be updated, which methods to use, and any challenges you foresee.

Please note that some niche API surface (e.g., system-specific endpoints or the `remote_data` field) might not be available in the SDKs at this point. If you notice that we're using such API surface, please flag it to me.

As always, make sure to double-check and test the results to ensure they’re correct.

Alternatives

If your tech stack is not supported yet, you can still make use of the “Try It” button (open example) across our endpoint documentation pages to test our endpoints in your browser and get generated code snippets for several languages There is also our official OpenAPI specification which you can use together with open source tools (e.g., OpenAPI Generator) to generate a client libraries or type definitions.

Kombo Connect SDK

Apart from our server-side SDKs, we offer one more official library: the @kombo-api/connect JavaScript SDK. This does not directly interact with the Kombo API. Instead, you can use it in your frontend code to embed the Kombo Connect flow right inside your own application. This works regardless of the JavaScript framework you’re using. Check out our “Embedded flow” guide for more details.

​Server-side SDKs

​Migrating to Kombo SDKs

​Alternatives

​Kombo Connect SDK

Server-side SDKs

Migrating to Kombo SDKs

Alternatives

Kombo Connect SDK