Get absences

GET

hris

absences

cursor

string

page_size

integer

updated_after

string

include_deleted

enum<string>

ids

string

remote_ids

string

date_from

string

date_until

string

type_ids

string

employee_id

string

time_from

string, deprecated

time_until

string, deprecated

curl --request GET \
  --url https://api.kombo.dev/v1/hris/absences \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "22st2Ji8XpncEYEak8mvQgQF",
        "remote_id": "1348",
        "employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
        "approver_id": "AgXEispYPP1BbToHpqnqcpxy",
        "start_date": "2022-08-04",
        "end_date": "2022-08-05",
        "start_half_day": true,
        "end_half_day": false,
        "start_time": "13:15:00",
        "end_time": "17:00:00",
        "amount": 2,
        "unit": "DAYS",
        "status": "APPROVED",
        "employee_note": "Visiting my family.",
        "type_id": "xzZoKssDaMZAd62kxayzzQvD",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": "2022-08-07T14:01:29.196Z",
        "remote_data": null,
        "type": {
          "id": "xzZoKssDaMZAd62kxayzzQvD",
          "remote_id": "91",
          "name": "Vacation",
          "unit": "DAYS",
          "half_days_supported": true,
          "exact_times_supported": false,
          "remote_data": null,
          "changed_at": "2022-08-07T14:01:29.196Z",
          "remote_deleted_at": null
        }
      }
    ]
  }
}

Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)

Authorizations

Authorization

string

headerrequired

Create an API key on the Secrets page in the Kombo dashboard.

Headers

X-Integration-Id

string

required

ID of the integration you want to interact with.

Query Parameters

cursor

string

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_size

integer

default: 100

The number of results to return per page.

updated_after

string

Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.

include_deleted

enum<string>

default: false

By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.

Available options:

true,

false

ids

string

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3. Those IDs are validated to be 24 characters long and to exist for this integration in the database. If any of the IDs are don't exist, the endpoint will return a 404 error.

remote_ids

string

Filter by a comma-separated list of remote IDs.

date_from

string

Filter for all the absences that either start or haven't ended yet on/after this day. If you imagine a calendar displaying absences, this defines the left-most visible day. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.

date_until

string

Filter for absences that start on or before this day (but might continue after). If you imagine a calendar displaying absences, this defines the right-most visible day. This is a plain date (i.e., yyyy-MM-dd), all time information is discarded.

type_ids

string

Filter by a comma-separated list of absence type IDs.

employee_id

string

Filter by a specific employee using their ID.

time_from

string

deprecated

(⚠️ Deprecated - Use the date_from filter instead.) Filter for absences that either start after or start before and end after a certain time.

time_until

string

deprecated

(⚠️ Deprecated - Use the date_until filter instead.) Filter for absences that start before a certain time.

Response

200 - application/json

status

enum<string>

required

Available options:

success

data

object

required

data.next

string | null

required

Cursor string that can be passed to the cursor query parameter to get the next page. If this is null, then there are no more pages.

data.results

object[]

required

data.results.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.results.remote_id

string | null

required

The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.

data.results.employee_id

string

required

The Kombo ID of the employee to which the absence belongs to. The ID can be used to retrieve the employee from the get employees endpoint.

data.results.approver_id

string | null

requireddeprecated

(⚠️ Deprecated - We won't increase coverage for this feature) The Kombo ID of the employee who is responsible for approving this absence.

data.results.start_date

string | null

required

The date this absence starts in the yyyy-MM-dd format.

data.results.end_date

string | null

required

The date this absence ends in the yyyy-MM-dd format.

data.results.start_half_day

boolean | null

required

true if the absence starts in the middle of the day, false if not, and null if the absence type doesn't support half-day absences. If an absence goes across multiple days and start_half_day is set, it means that on the last day the absence is only on the first half of the day.

data.results.end_half_day

boolean | null

required

true if the absence ends in the middle of the day, false if not, and null if the absence type doesn't support half-day absences. If an absence goes across multiple days and end_half_day is set, it means that on the first day the absence only starts in the second half-day.

data.results.start_time

string | null

required

The time at which this absence starts. Follows the format HH:mm:ss (e.g., 14:45:15).

data.results.end_time

string | null

required

The time at which this absence ends. Follows the format HH:mm:ss (e.g., 14:45:15).

data.results.amount

number | null

required

The amount of time this absence takes.

data.results.unit

enum<string> | null

required

The unit of time for this absence. Can be HOURS or DAYS.

Available options:

HOURS,

DAYS

data.results.status

The absence’s current status. In rare cases where we can’t find a clear mapping, the original string is passed through.

Available options:

REQUESTED,

APPROVED,

DECLINED,

CANCELLED,

DELETED

data.results.employee_note

string | null

required

A note the employee has added to this absence.

data.results.type_id

string | null

required

The Kombo absence type ID of this absence.

data.results.changed_at

string

required

The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.

data.results.remote_deleted_at

string | null

required

The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.

data.results.remote_data

object | null

required

Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set.

Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: { "/companies": { ... }}

This is not available on all plans. Reach out to Kombo if you need it.

data.results.type

object | null

required

Get work locations Get absence types

curl --request GET \
  --url https://api.kombo.dev/v1/hris/absences \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Integration-Id: <x-integration-id>'

{
  "status": "success",
  "data": {
    "next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
    "results": [
      {
        "id": "22st2Ji8XpncEYEak8mvQgQF",
        "remote_id": "1348",
        "employee_id": "JDdUy9kiH5APaGizFrgNmQjM",
        "approver_id": "AgXEispYPP1BbToHpqnqcpxy",
        "start_date": "2022-08-04",
        "end_date": "2022-08-05",
        "start_half_day": true,
        "end_half_day": false,
        "start_time": "13:15:00",
        "end_time": "17:00:00",
        "amount": 2,
        "unit": "DAYS",
        "status": "APPROVED",
        "employee_note": "Visiting my family.",
        "type_id": "xzZoKssDaMZAd62kxayzzQvD",
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": "2022-08-07T14:01:29.196Z",
        "remote_data": null,
        "type": {
          "id": "xzZoKssDaMZAd62kxayzzQvD",
          "remote_id": "91",
          "name": "Vacation",
          "unit": "DAYS",
          "half_days_supported": true,
          "exact_times_supported": false,
          "remote_data": null,
          "changed_at": "2022-08-07T14:01:29.196Z",
          "remote_deleted_at": null
        }
      }
    ]
  }
}

General

Features

General API Reference

HRIS API Reference

DATEV API Reference

Get absences

Authorizations

Headers

Query Parameters

Response