Skip to main content
GET
List Absence

Authorizations

x-API-Key
string
header
required

Query Parameters

limit
integer
default:100

Maximum number of items to return

Required range: 1 <= x <= 1000
offset
integer
default:0

Number of items to skip for pagination

Required range: x >= 0
sort
string

JSON-encoded sort object with "by" (field path) and "direction" (1 for asc, -1 for desc)

Example:

"{\"by\":\"number\",\"direction\":1}"

userIdsByName
string

Filter something (e.g. keys) by the assigned user's name or number

Response

List of Absence items

_id
string<objectid>

Unique identifier for the absence

number
integer

Unique number of the entity, used for identification

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Status struct for the absence

chatId
string<objectid> | null

ID of the chat associated with this entity

userId
string<objectid>

User ID for whom the absence is recorded

type
integer

Absence type (e.g., illness, vacation, unpaid leave)

payTypeAbsenceId
string<objectid> | null

Pay type absence ID

calculationType
string | null

Calculation type for the absence

desc
string | null

Description or comment for the absence

dtStart
string<date-time>

Start date/time of the absence

dtEnd
string<date-time>

End date/time of the absence

daysAbsent
number<float>

Number of days absent. Server output for SHADOW and LEDGER. For LEGACY a client value stays authoritative.

startHalf
boolean

Count only the second half of the first day

endHalf
boolean

Count only the first half of the last day

days
object[]

Counted day list. Each item has date, amount (1, 0.5 or 0), reason and optional holidayName and override.

dayCountMismatch
object | null

Set when a legacy client sent a daysAbsent that differs from the server count

fullDay
boolean

Whether the absence is for a full day

approvedBy
string<objectid> | null

User ID who approved the absence

declinedBy
string<objectid> | null

User ID who declined the absence

affectedJobs
string<objectid>[]

List of job IDs affected by this absence

isAssigned
boolean

Whether all replacement jobs are assigned

attachments
string[]

Attachment IDs or file references

imageIds
string[]

Image IDs associated with the absence

objectManagerIds
string<objectid>[]

IDs of object managers

declineComment
string | null

Comment for declined absence

sendEmailToCustomer
boolean

Whether to send an email to the customer

affectedObjectIds
string<objectid>[]

IDs of affected objects

absencePaidTimeArray
object[]

Paid time for each day of the absence

replacements
object[]

Replacement assignments for the absence