HRIS

ATS Assessment

Status

Kombo

Overview

Speak to an expert

Dashboard

Update candidate 🦄

Currently in closed beta.
<Warning>**This endpoint is currently in closed beta!** We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>

ApiKey

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

Introduction

Our interactive embeddable connection flow.

Kombo Connect

Reading and writing data

How to make Kombo's unified models fit your product

Extending the model

Customize the data that is being synced by Kombo.

Permissions and scopes

Support

Your hub for developing and configuring your integrations

The dashboard

Understanding Kombo’s data handling, security, and regional deployment options

Platform Architecture

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

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

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

Sandbox Integrations

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

Context

Setup

Connection setup

Reading employees

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

Learn about SFTP transfers and their potential benefits.

SFTP connections

Beyond Connection Flow: Setup Flow. Let your users configure their integration.

Setup Flow [BETA]

Learn how to use custom fields to read additional data properties from your customer's systems.

Custom Fields

Learn how to use integration fields to read additional data properties from your customer's systems.

Integration Fields

Learn how Kombo's logs allow you to monitor and troubleshoot your integrations.

Logs

Deletion Policy

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

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

Scopes

Audit sensitive changes to your Kombo environment.

Audit Logs

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 why and how to reconnect an integration.

Reconnecting an integration

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

Real-time sync

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

Webhooks

Kombo can subscribe to webhooks of the systems that your customers connect. We call this feature upstream webhooks. This document explains how they work and how you can leverage them.

Upstream webhooks

Integration States

Learn about best practices when using a new tool.

Implementing New Tools

Environments

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

Partner Credentials

Get employees

Get employments

Get timesheets 🦄

Create employee

Update writable integrations fields on Employees in the remote system.

Update fields on Employees

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

Get groups

Get legal entities

Get work locations

Get employee document categories

Uploads an document file for the specified employee.

Add document to employee

Get absences

Get absence types

Get time off balances

Create absence

Delete absence

Get attendance 🦄

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

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

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

Create provisioning setup link

Get all custom fields available on the specified integration.

Get custom fields with current mappings

Updates the mapping of a given custom field. If the custom field is already mapped, it will be updated.

Put custom field mappings

Get all fields available on the specified integration.

Get integration fields

When enabled, the integration field will be passed as part of the `integration_fields` array on the specific model endpoint. Providing false will disable the passthrough for the specified field.

Updates an integration fields passthrough setting

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 integration with Kombo.

Getting Started

This endpoint returns whether you can write to this DATEV integration.

Verify service is enabled

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

This endpoint returns BeraterNr (consultant_number), MandantenNr (client_number) and the payroll system (LODAS or Lohn und Gehalt). Useful to generate a DATEV ASCII file for the passthrough endpoint.

Get DATEV system information

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

This endpoint returns the available document types for this DATEV integration.

Use this endpoint to get all available documents for a specific period.

Retrieve available documents

Download Employee Document

Download Company Document

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

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

Create eAU Request

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

Query the status of the eAU request

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

Legacy write-only DATEV Integration guide

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

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

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

Reading jobs

Creating applications

Tracking created applications

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

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

Rejects an application with a provided reason.

Reject application

Get Interviews

Get candidates

Create a new candidate and application for the specified job.

Create candidate

Get attachments from a candidate, including all attachments of all of their applications.

General

Features

Guides

ATS API Reference

General API Reference

Update candidate 🦄

Authorizations

Headers

Path Parameters

Body

Response