Zum Hauptinhalt springen
GET
Read a request by id

Autorisierungen

X-API-KEY
string
header
erforderlich

Pfadparameter

id
string<uuid>
erforderlich
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Abfrageparameter

locale
enum<string>
Verfügbare Optionen:
en,
de,
fr,
hu,
it,
pl,
pt,
ru,
es,
tr,
uk

Antwort

object | null

Successful response

id
string
erforderlich
createdAt
string
erforderlich
updatedAt
string
erforderlich
end
string
erforderlich
start
string
erforderlich
start_at
enum<string>
erforderlich

For day-based leave types: whether the absence starts in the morning (the whole first day counts) or afternoon (only the second half of the first day). Ignored for hour-based leave types.

Verfügbare Optionen:
morning,
afternoon
end_at
enum<string>
erforderlich

For day-based leave types: whether the absence ends at lunchtime (only the first half of the last day) or end_of_day (the whole last day counts). Ignored for hour-based leave types.

Verfügbare Optionen:
lunchtime,
end_of_day
leave_unit
enum<string>
erforderlich

The unit stored on this request. It governs duration and workday_absence_duration: day and half-day units use days; hour and minute units use minutes. It may differ from leave_type.leave_unit after the leave type changes.

Verfügbare Optionen:
days,
half_days,
hours,
minutes_30,
minutes_15,
minutes_10,
minutes_5,
minutes_1
revision
integer
erforderlich

Counts the versions of the request. Starts at 1 and goes up with every applied change. A pending, declined or withdrawn change does not change it.

Erforderlicher Bereich: -9007199254740991 <= x <= 9007199254740991
last_changed_at
string | null
erforderlich

When the request was last changed, or null if it never was.

pending_change
object | null
erforderlich

The change that waits for a decision on an approved request, or null. The request fields still show the approved version until the change is applied.

request_creator_member
object | null
erforderlich
leave_type
object
erforderlich
approval_process
enum<string>
erforderlich
Verfügbare Optionen:
Linear_all_have_to_agree,
Linear_one_has_to_agree,
Parallel_all_have_to_agree,
Parallel_one_has_to_agree,
Parallel_first_response_decides
needs_approval
boolean | null
erforderlich

Whether the request needed approval, as recorded when it was created. When false, the approver rows were approved automatically. Null for requests created before this was recorded.

cancel_reason
string | null
erforderlich
canceld_by_member
object | null
erforderlich
requester_member
object | null
erforderlich
take_from_allowance
boolean
erforderlich
allowance_type
object | null
erforderlich
reason
string | null
erforderlich
workday_absence_duration
number
erforderlich

Counted duration, the value absentify shows: the working time the absence takes, based on the work schedule and public holidays, unless the leave type also counts days off or public holidays. Days for day and half-day leave units, minutes for hour and minute units. If the leave type deducts from an allowance, this is the amount the absence takes from it, or for a proposed change, would take once the change applies. Canceled and declined requests keep the value but take nothing from the allowance.

duration
number
erforderlich

Calendar duration, including non-working days and non-working time: calendar days for day and half-day leave units, elapsed minutes from start to end for hour and minute units. Use workday_absence_duration for the counted duration.

status
string
erforderlich
canceld_date
string | null
erforderlich
request_approvers
object[]
erforderlich
request_representative_approvers
object[]
erforderlich