HRIS API

ATS API

ATS-Assessment API

Status

Kombo

Book Demo

Dashboard

Learn how to get access to tools you can connect to Kombo for development purposes.

Sandbox Integrations

Learn how you can put integrations on autopilot through Kombo's unified APIs.

Introduction

Let's get you up and running with our API!

Overview

Creating Integrations

Learn how to authenticate with the Kombo API.

Authentication

Learn how to filter and paginate the Kombo `GET` endpoints. This will help you understand how to implement syncs and more.

Fetching Data

Learn how to get the newest data back from us after every sync.

Syncing Data

Learn how to use remote data to access any available field.

Remote Data

Our interactive embeddable connection flow.

Manually set up integrations on behalf of your customers.

Manual setup

Let your customers set up integrations without changing your app.

Magic links

Embed Kombo Connect into your app for the most seamless experience.

Embedded flow

This document explains how to reconnect an integration whose authentication credentials are no longer valid.

Reconnecting a stale integration

Scopes allow you to customize what data is being synced by Kombo.

Scopes

How Kombo keeps integration data up-to-date without sacrificing API reliability and performance.

Real-time sync

Learn how to use custom fields to read any data from your customers.

Custom Fields

Kombo sends you webhooks so that you don't have to poll our API for changes.

Webhooks

Request Logs

Integration States

Learn about best practices when using a new tool.

Implementing New Tools

Deletion Policy

Learn how existing partnerships to integrated systems can be used with Kombo.

Partner Credentials

Implement any edge case feature with our passthrough API.

Passthrough API

Learn how Kombo allows you to write additional, otherwise unsupported fields with unified write actions.

Extend write endpoints

Generate a unique link that allows your user to enter the embedded Kombo Connect flow.

Create connection link

Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. 

Get integration by token

Use this endpoint with the token you get from the connection flow to retrieve information about the created integration. It works in a similar way as the OAuth2 code flow to securely retrieve information and connect the integration to your user. You do not need to call this endpoint for an integration to become active.

Activate integration (optional)

Create a link that will allow the user to reconnect an integration. This is useful if you want to allow your users to update the credentials if the old ones for example expired.

Create reconnection link

Get a list of the tools (i.e., integrations) enabled in your environment.

Get tools

Create a new link that can be passed to the Kombo Connect SDK to open the provisioning setup UI.

Create provisioning setup link

Get the specified integration with everything you need to display it to your customer.

Get integration details

Delete integration

Trigger a sync for a specific integration.

Trigger sync

Check whether your API key is working properly.

Check API key

Send a request to the specified integration's native API.

Send passthrough request

Learn how to set up a DATEV payroll integration with Kombo.

DATEV Integration

Learn how to get started with Kombo's unified HRIS API.

Getting started

Learn how properly utilize the Absence functionality.

Create and read absences

Learn what the filtering feature is and when to use it.

How we make our filtering feature compliant.

Data deletion

What we have planned for the filtering feature in the near future.

Roadmap

Learn about SFTP transfers and their potential benefits.

SFTP connections

Context

Setup

Connection setup

Reading employees

Get employees

Get employments

Create employee

Update employee

Add attachment to employees 🦄

Retrieve all "groups" (teams, departments, and cost centers).

Get groups

Get legal entities

Get work locations

Get absences

Get absence types

Get time off balances

Create absence

Delete absence

This action allows to send an arbitrary ASCII file directly to DATEV LODAS or Lohn und Gehalt. Kombo adds validation for the file format but not on the content. This action allows you to implement any use case that you might have with DATEV payroll ASCII imports.

Write raw DATEV ASCII file

What DATEV requires to prepare payroll is very specific and currently, as DATEV is not providing "read", this is not part of the unified model.

Prepare DATEV Payroll

Sets the compensations for an employee on the specified effective date.

Set DATEV compensations

Returns all "DATEV Data Pushes" of the last 2 months. You can use this endpoint to give your users transparency about submitted "ASCII-Files" and their status. Each data push can contain multiple files that were submitted.

Get DATEV data pushes

Uploads the currently relevant general data (employees, compensations, and time offs) to DATEV. This will create so called ASCII files that the accountant has to import in DATEV. You can call this endpoint to implement an on-demand sync to DATEV, for example if you want to offer your users a button to do that in your application.

Push general data to DATEV

Uploads the currently relevant payroll data (supplements) to DATEV. This will create so called ASCII files that the accountant has to import in DATEV. After finishing the payroll preparation or after correcting payroll, you can call this.

Push payroll data to DATEV

Create a request for an electronic certificate of incapacity for work (eAU).

Create eAU Request

This endpoint validates that this DATEV integration is ready to use the eAU feature.

Verify eAU is ready for this DATEV integration

This endpoint queries the status of the eAU request for the given DATEV integration.

Query the status of the eAU request

Learn how to get started with Kombo's unified ATS API.

Learn how to attach source information to applications easily.

Application attribution

Application tracking

Attach your candidates' answers to screening questions when creating applications.

Screening questions

Reading jobs

Creating applications

Tracking created applications

Testing

Get jobs

Get all application stages available in the ATS.

Get application stages

Get Job Postings

Get applications

Create a new application and candidate for the specified job.

Create application

Uploads an attachment file for the specified applicant.

Add attachment to application

Moves an application to a specified stage.

Move application to stage

Add result link to application

Add note to application

Get attachments from a candidate or application.

Get application attachments

Get Interviews

Get candidates

Create a new candidate and application for the specified job.

Create candidate

Uploads an attachment file for the specified candidate.

Add attachment to candidate

Add result link to candidate

Update candidate 🦄

Get tags

Add tag to candidate

Remove a tag from a candidate based on its name.

Remove tag from candidate

Get users

Learn how to get started with Kombo's unified ATS-Assessment API.

How it works

Replaces the list of available assessment packages.

Set packages

Get all available assessment packages for an integration.

Get packages

Get all open assessment orders of an integration.

General

Features

General API Reference

Guides