Retrieve the attendance of an employee

This API requires a date range and the employee id of the employee whose attendance is intended.

it returns an object list indicating attendance in the sate range, below is the details of the object

Response Model

Json propertyData typeDescription
attendancearray of objects (EmployeeAttendanceViewModel)List of attendance records.
total_recordsintegerTotal number of attendance records available.
break_periodsarray of objects (EmployeeBreakTime)List of employee break periods.
approval_requestsarray of objects (RequestedCheckinDetails)List of pending approval requests.
timeoffsarray of objects (TimeOffDetails)List of employee time-off details.

EmployeeAttendanceViewModel

Json propertyData typeDescription
durationinMinutesint?Total worked duration between check-in and check-out, expressed in minutes.
reasonReasonReason metadata associated with the attendance entry, when available in responses.

EmployeeBreakTime

Json propertyData typeDescription
dateDateTime?Attendance date associated with this break period entry, if available.
start_timestringBreak start time captured for the employee, formatted as a time string.
end_timestringBreak end time captured for the employee, formatted as a time string.
is_duration_completestringIndicates whether the break met required duration; typically “true” or “false”.

RequestedCheckinDetails

Json propertyData typeDescription
request_idGuid?Unique identifier of the attendance update request created by the employee or admin.
commentstringFree-text comment explaining the requested attendance change or context.
statusApprovalStatusApproval status of the request, such as pending, approved, or rejected.
status_updated_byGuidIdentifier of the user who last updated the request’s approval status.
is_meal_breakbool?Indicates whether the requested change concerns a meal break period.
attendance_dateDateTimeAttendance date for which the request applies, using location’s timezone.
check_in_timeDateTimeProposed or recorded check-in time associated with the approval request.
check_out_timeDateTime?Proposed or recorded check-out time associated with the approval request.
work_taskWorkTaskAssociated work task information for the attendance request, when provided.
reasonMiisedCheckinReasonReason specifying missed or adjusted check-in context for the request.
attendance_idInt32?Existing attendance record identifier related to this approval request, if any.
durationint?Duration in minutes for the request’s attendance window or adjustment.

TimeOffDetails

Json propertyData typeDescription
employee_idGuidUnique identifier of the employee taking the time off entry.
time_off_dateDateTimeCalendar date on which the employee’s time off is scheduled or recorded.
eto_commentsstringAdditional comments captured for the earned time off entry, if provided.
time_off_idGuidUnique identifier for the specific time off record instance.
typeTimeOffTypeCategory of the time off entry such as mandatory break or vacation.
time_off_in_minutesintTotal minutes of time off allocated or consumed for this entry.
is_mandatory_break_completeboolIndicates whether the required mandatory break duration has been completed.

TimeOffType (enum)

Json propertyData typeDescription
MandatoryBreakenum valuePaid or unpaid mandatory break time required during scheduled working hours.
HolidayHoursenum valueHours allotted for holidays according to organization or regional policy.
VacationHoursenum valueHours allotted for planned vacation or personal leave taken by employees.

ApprovalStatus (enum)

Json propertyData typeDescription
values not providedenum valuePossible statuses like pending, approved, or rejected; exact values depend on implementation.

MissedCheckinReason (enum)

Json propertyData typeDescription
values not providedenum valueReasons describing missed or corrected check-ins; actual values defined elsewhere.
Language
Credentials
Header
Click Try It! to start a request and see the response here!