List the configured absence reasons

Returns every absence reason available for booking, e.g. vacation or sick leave, together with the rules that govern how it may be booked.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/absence-reasons

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/absence-reasons' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.
Name
external_id
Type
string, nullable
Description
Restricts the list to the absence reason mapped onto this identifier in a connected external system.

Response

{
  "data": [
    {
      "name": "EU",
      "comment": "Elternurlaub|en:Parental leave",
      "approve": true,
      "allow_self_entry": true,
      "allow_half_day_holiday": 1,
      "allow_hours_of_vacation": 1,
      "anyone_can_see_name": true,
      "color": "#664599",
      "type": {
        "id": 1,
        "name": "annual holiday"
      },
      "client_calendar_category": "string",
      "inform_employee_upon_approval_or_revocation": 1,
      "external_id": "string",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response fields

Name
name
Type
string
Description
Unique short code identifying the reason; also its route key.
Name
comment
Type
string, nullable
Description
Free-text note shown alongside the reason in the calendar and reports.
Name
approve
Type
boolean, nullable
Description
Whether a booking with this reason needs approval before it counts.
Name
allow_self_entry
Type
boolean
Description
Whether employees may book this reason themselves without going through a supervisor.
Name
allow_half_day_holiday
Type
integer, nullable
Description
Whether this reason can be booked for half a day instead of only full days.
Name
allow_hours_of_vacation
Type
integer, nullable
Description
Whether this reason can be booked in individual hours instead of only whole days.
Name
anyone_can_see_name
Type
boolean, nullable
Description
Whether colleagues who did not book the absence can still see this reason’s name.
Name
color
Type
string
Description
Colour used to highlight bookings of this reason in the calendar.
Name
type
Type
object, nullable
Description
The category of absence this reason represents, e.g. annual holiday, paid or unpaid absence, flexitime or homeoffice.
Name
type.id
Type
integer
Description
The stored value. Compare against this, not against name.
Name
type.name
Type
string
Description
The human-readable label, delivered in the tenant’s language. Do not parse it.
One of: "annual holiday", "paid absence", "unpaid absence", "flexitime", "time off in lieu for business travel", "homeoffice"
Name
client_calendar_category
Type
string, nullable
Description
Category this reason maps onto in an external calendar synced from the client.
Name
inform_employee_upon_approval_or_revocation
Type
integer, nullable
Description
Whether the employee is emailed when a booking of this reason is approved or revoked.
Name
external_id
Type
string, nullable
Description
Identifier used to map this reason onto the matching absence type in a connected external system.
Name
created
Type
string (date-time), nullable
Description
Timestamp the reason was created.
Name
modified
Type
string (date-time), nullable
Description
Timestamp the reason was last modified.

Generated from the OpenAPI specification — edit the source code, not this page.

Absence Reasons GET Retrieve a single absence reason