ConnectCloud Developers

Absence types, holidays and working-time settings (tenant:access)

GET /api/hr/v1/work-config

Module: HR · operationId: getWorkConfig · Tag: Absences · Auth: access token (Authorization: Bearer <accessToken>)

Responses

  • 200 Configuration (application/json)

Fields of the 200 answer:

  • absenceTypes (array of AbsenceType): Absence types of the tenant
    • key (string, required): Stable key of the type
    • name (string, required): Display name
    • allowHalfDays (boolean): Half days may be requested
    • archived (boolean): Archived: no longer offered for new data, kept for existing data
    • color (string): Semantic colour of the type in calendars (one of primary, info, success, warning, error, neutral)
    • countsAgainstVacation (boolean): Days of this type are taken from the vacation account
    • icon (string): Lucide icon (i-lucide-…)
    • id (string): Id of the absence type
    • paid (boolean): The absence is paid time
    • requiresApproval (boolean): Requests start as requested and need a decision; otherwise they are approved when entered
    • sensitive (boolean): Colleagues see only "abwesend"
    • sortOrder (integer): Position in lists (ascending)
    • timeEffect (string): credit: counts as worked; none: the time account pays (Überstundenabbau); reduce_target: no target (unpaid) (one of credit, none, reduce_target)
    • version (integer): Version for optimistic locking: send the version you read with a change (stale: 409 version_conflict)
  • customHolidays (array of CustomHoliday): The tenant's own holidays
    • date (string (date), required): Date (YYYY-MM-DD)
    • fraction (number, required): 1 for a full day, 0.5 for a half day (one of 0.5, 1)
    • name (string, required): Name of the holiday
    • id (string): Id of the tenant holiday
    • recurring (boolean): Every year on the same day
    • version (integer): Version for optimistic locking: send the version you read with a change (stale: 409 version_conflict)
  • federalStates (array of FederalState): German states (Bundesländer) to choose from
    • code (string): ISO 3166-2 suffix of the state (BW, BY, …)
    • name (string): Name of the state
  • workSettings (WorkSettings)
    • absencesVisibleToColleagues (boolean): Colleagues see each other's absences in the team calendar and presence; off: only the caller and the people they decide for
    • autoEndAtMidnight (boolean): A clock segment nobody clocked out of is ended at 24:00 of its day (tenant time zone) and marked autoEnded for checking. Off for tenants whose shifts run past midnight. (default true)
    • carryoverExpiry (string): MM-DD the previous year's vacation expires (default "03-31")
    • defaultDayMinutes (array of integer): Target minutes Monday … Sunday without a working-time model
    • defaultVacationDays (number): Vacation days per year of employees without a working-time model
    • federalState (string): Bundesland code (BW, BY, …); empty = nationwide holidays only
    • selfEditDays (integer): Days back employees change their own time without a reason
    • timeZone (string): IANA time zone of the tenant, e.g. Europe/Berlin (default "Europe/Berlin")
    • trackingStart (string (date)): First day time accounts count

Example 200 answer:

{
  "absenceTypes": [
    {
      "allowHalfDays": true,
      "archived": false,
      "color": "primary",
      "countsAgainstVacation": true,
      "icon": "i-lucide-palmtree",
      "id": "8c0e2a4c-6e8a-4c0e-9a4c-6e8a0c2e4a13",
      "key": "vacation",
      "name": "Erholungsurlaub",
      "paid": true,
      "requiresApproval": true,
      "sensitive": false,
      "sortOrder": 10,
      "timeEffect": "credit",
      "version": 1
    },
    {
      "allowHalfDays": true,
      "archived": false,
      "color": "error",
      "countsAgainstVacation": false,
      "icon": "i-lucide-thermometer",
      "id": "9e2a4c6e-8a0c-4e2a-9c6e-8a0c2e4a6c16",
      "key": "sick",
      "name": "Krankheit",
      "paid": true,
      "requiresApproval": false,
      "sensitive": true,
      "sortOrder": 20,
      "timeEffect": "credit",
      "version": 1
    }
  ],
  "customHolidays": [
    {
      "date": "2026-12-24",
      "fraction": 0.5,
      "id": "0e2a4c6e-8a0c-4e2a-8c6e-8a0c2e4a6c14",
      "name": "Heiligabend (halber Tag)",
      "recurring": true,
      "version": 1
    }
  ],
  "federalStates": [
    {
      "code": "BY",
      "name": "Bayern"
    },
    {
      "code": "BW",
      "name": "Baden-Württemberg"
    }
  ],
  "workSettings": {
    "absencesVisibleToColleagues": true,
    "autoEndAtMidnight": true,
    "carryoverExpiry": "03-31",
    "defaultDayMinutes": [
      480,
      480,
      480,
      480,
      480,
      0,
      0
    ],
    "defaultVacationDays": 30,
    "federalState": "BY",
    "selfEditDays": 14,
    "timeZone": "Europe/Berlin",
    "trackingStart": "2026-01-01"
  }
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/hr/v1/work-config' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI