Single Attendance Record - User Report API
This API is used to get attendance details of employees from the attendance reports page. Details that are present in the user report like overtime/deviation time, total working hours, etc. for a particular employee and a particular period chosen can be extracted with the help of this API.
Request URL
https://people.zoho.com/people/api/attendance/getUserReport?sdate=<sdate>&edate=<edate>&empId=<employeeId>&emailId=<emailId>&mapId=<mapId>&dateFormat=<dateFormat>
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
​Request Parameters
| sdate | Specify the correct start date |
| edate | Specify the correct end date |
| empId | Specify the employee ID of an employee |
| emailId | Specify the email ID of an employee |
| mapId | Specify the mapper ID of an employee |
| dateFormat | Specify the date format for the given date. Eg: yyyy-MM-dd (optional) |
Note
- Start date and end date should be in the format specified in the company settings or in the date format you have mentioned in the parameter.
- Out of the 3 parameters - Emp ID, Email ID & Map ID, at least one of them must be given as input to map the entry of an employee. Mapper ID is the unique ID of your Attendance system like the Biometric system which marks the attendance for a specific employee.
Multiple Attendance Records - User Report API
This API is used to get the attendance details of 100 employees from the attendance reports page in one request. To fetch the next 100 employees' attendance simply modify startIndex as 100, and 200 for the next 100 employees, and so on.
Request URL
https://people.zoho.com/people/api/attendance/getUserReport?sdate=<sdate>&edate=<edate>>&dateFormat=<dateFormat>&startIndex=<startIndex>
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
​Request Parameters
| sdate | Specify the correct start date |
| edate | Specify the correct end date |
| startIndex | Specify where to start for fetching 100 employee attendance details at once. Example 0, returns the first 100 employees |
| dateFormat | Specify the date format for the given date. Eg: yyyy-MM-dd (optional) |
Threshold Limit: 100 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Sample Response - Single Record
Copied{
"2020-03-16": {
"ShiftStartTime": "09:00 AM",
"Status": "Sick",
"paidBreakHours": "00:00",
"OverTime": "00:00",
"LastOut_Location": "-",
"ShiftName": "Noon",
"unPaidBreakHours": "00:00",
"FirstIn": "16-Mar-2020 09:20 AM",
"FirstIn_Location": "-",
"TotalHours": "00:00",
"WorkingHours": "08:00",
"LastOut": "16-Mar-2020 09:20 AM",
"ShiftEndTime": "09:00 PM"
}
}Sample Response - Multi Record (100 Users)
Copied{
"result": [
{
"attendanceDetails": {
"2020-03-21": {
"ShiftStartTime": "10:00 PM",
"Status": "Absent",
"paidBreakHours": "00:00",
"LastOut_Location": "-",
"ShiftName": "Third",
"unPaidBreakHours": "00:00",
"FirstIn": "-",
"FirstIn_Location": "-",
"TotalHours": "00:00",
"WorkingHours": "00:00",
"LastOut": "-",
"DeviationTime": "08:00",
"ShiftEndTime": "06:00 AM"
}
},
"employeeDetails": {
"mail id": "kumar.k@abc.om",
"erecno": "609835000000452022",
"last name": "Kumar",
"first name": "Selva",
"id": "1"
}
},
{
"attendanceDetails": {
"2020-03-21": {
"ShiftStartTime": "10:00 PM",
"Status": "Absent",
"paidBreakHours": "00:00",
"LastOut_Location": "-",
"ShiftName": "Third",
"unPaidBreakHours": "00:00",
"FirstIn": "-",
"FirstIn_Location": "-",
"TotalHours": "00:00",
"WorkingHours": "00:00",
"LastOut": "-",
"DeviationTime": "08:00",
"ShiftEndTime": "06:00 AM"
}
},
"employeeDetails": {
"mail id": "karthiga.g@abc.com",
"erecno": "609835000000452023",
"last name": "Selvi",
"first name": "Karthiga",
"id": "2"
}
}
],
"message": "Success",
"uri": "/api/attendance/getUserReport",
"status": 0
}