{"id":4771,"date":"2026-10-12T17:44:46","date_gmt":"2026-10-12T14:44:46","guid":{"rendered":"https:\/\/modulus.help\/kb\/?post_type=docs&p=4771"},"modified":"2026-10-12T17:51:42","modified_gmt":"2026-10-12T14:51:42","slug":"api-list-attendance-logs","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/personnel-apis-v1\/api-list-attendance-logs\/","title":{"rendered":"API: List Attendance Logs"},"content":{"rendered":"

The purpose of this API is to retrieve employee attendance logs within a specified date range, with an optional employee filter. Results are ordered by log_date_time ascending.<\/p>\n

Request<\/h4>\n\n\n\n\n\n\n\n\n\n\n
Property<\/th>\nValue<\/th>\n<\/tr>\n<\/thead>\n
API Name<\/td>\nAttendanceLog<\/td>\n<\/tr>\n
URL<\/td>\nhttps:\/\/your_account.modulus.biz\/api\/hr\/v1\/AttendanceLog<\/td>\n<\/tr>\n
Method<\/td>\nGET<\/td>\n<\/tr>\n
Source<\/td>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/td>\nmodulus\u00ae Server<\/td>\n<\/tr>\n
Accept<\/td>\napplication\/json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Request Headers<\/h4>\n\n\n\n\n\n\n
Header<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Authorization<\/td>\nYes<\/td>\nBearer token for authentication. Format: Bearer <token><\/td>\n<\/tr>\n
Accept<\/td>\nYes<\/td>\napplication\/json<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Query String Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
employee_code<\/td>\nNo<\/td>\nString<\/td>\nFilter by employee code. If omitted, logs for all employees are returned.<\/td>\n<\/tr>\n
date_from<\/td>\nYes<\/td>\nDate<\/td>\nStart date in YYYY-MM-DD format (inclusive).<\/td>\n<\/tr>\n
date_to<\/td>\nYes<\/td>\nDate<\/td>\nEnd date in YYYY-MM-DD format (inclusive). May equal date_from.<\/td>\n<\/tr>\n
page_number<\/td>\nNo<\/td>\nInteger<\/td>\nPage number. Default = 1.<\/td>\n<\/tr>\n
page_size<\/td>\nNo<\/td>\nInteger<\/td>\nNumber of records per page. Default = 50.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n
HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n<\/thead>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nAttendance logs listed successfully.<\/td>\nmeta_data and data<\/td>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nNo attendance logs found matching your conditions.<\/td>\nmeta_data and empty data array<\/td>\n<\/tr>\n
400 Bad Request<\/td>\nfalse<\/td>\nInvalid Request<\/td>\ndate_to is required.
\ndate_from is required.<\/td>\n		null<\/td>\n<\/tr>\n
400 Bad Request<\/td>\nfalse<\/td>\nInvalid Request<\/td>\ndate_from must be earlier than or equal to date_to.<\/td>\nnull<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example 1 – All Employees<\/h4>\n\n\n\n\n
Request<\/td>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/AttendanceLog?date_from=2026-09-01&date_to=2026-09-30&page_number=1&page_size=50' \\\n--header 'Accept: application\/json' \\\n--header 'Authorization: Bearer <token>'<\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/td>\n\n
{\n  \"result\": true,\n  \"title\": \"Success\",\n  \"message\": \"Attendance logs listed successfully.\",\n  \"object\": {\n    \"meta_data\": {\n      \"page_count\": 3,\n      \"page_number\": 1,\n      \"page_size\": 50,\n      \"record_count\": 127\n    },\n    \"data\": [\n      {\n        \"employee_code\": \"0001\",\n        \"log_date_time\": \"2026-09-15 08:57\",\n        \"collected_on\": \"2026-09-15 08:57:33\",\n        \"source\": \"GPS\",\n        \"status\": \"PROCESSED\",\n        \"direction\": \"IN\",\n        \"device\": null,\n        \"location\": {\n          \"id\": 3,\n          \"name\": \"Cairo HQ\"\n        },\n        \"coordinate\": {\n          \"longitude\": 31.2357123,\n          \"latitude\": 30.0444196\n        },\n        \"notes\": null\n      },\n      {\n        \"employee_code\": \"0002\",\n        \"log_date_time\": \"2026-09-15 09:02\",\n        \"collected_on\": \"2026-09-15 09:02:18\",\n        \"source\": \"DEVICE\",\n        \"status\": \"PROCESSED\",\n        \"direction\": \"IN\",\n        \"device\": {\n          \"id\": 8,\n          \"label\": \"Main Entrance\"\n        },\n        \"location\": {\n          \"id\": 3,\n          \"name\": \"Cairo HQ\"\n        },\n        \"coordinate\": null,\n        \"notes\": null\n      }\n    ]\n  }\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 2 – One Employee<\/h4>\n\n\n\n\n
Request<\/td>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/AttendanceLog?employee_code=0001&date_from=2026-09-01&date_to=2026-09-30&page_number=1&page_size=50' \\\n--header 'Accept: application\/json' \\\n--header 'Authorization: Bearer <token>'<\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/td>\n\n
{\n  \"result\": true,\n  \"title\": \"Success\",\n  \"message\": \"Attendance logs listed successfully.\",\n  \"object\": {\n    \"meta_data\": {\n      \"page_count\": 1,\n      \"page_number\": 1,\n      \"page_size\": 50,\n      \"record_count\": 1\n    },\n    \"data\": [\n      {\n        \"employee_code\": \"0001\",\n        \"log_date_time\": \"2026-09-15 08:57\",\n        \"collected_on\": \"2026-09-15 08:57:33\",\n        \"source\": \"GPS\",\n        \"status\": \"PROCESSED\",\n        \"direction\": \"IN\",\n        \"device\": null,\n        \"location\": {\n          \"id\": 3,\n          \"name\": \"Cairo HQ\"\n        },\n        \"coordinate\": {\n          \"longitude\": 31.2357123,\n          \"latitude\": 30.0444196\n        },\n        \"notes\": null\n      }\n    ]\n  }\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 3 – No Matching Logs<\/h4>\n\n\n\n\n
Request<\/td>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/AttendanceLog?employee_code=9999&date_from=2026-09-01&date_to=2026-09-30' \\\n--header 'Accept: application\/json' \\\n--header 'Authorization: Bearer <token>'<\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/td>\n\n
{\n  \"result\": true,\n  \"title\": \"Success\",\n  \"message\": \"No attendance logs found matching your conditions.\",\n  \"object\": {\n    \"meta_data\": {\n      \"page_count\": 0,\n      \"page_number\": 1,\n      \"page_size\": 50,\n      \"record_count\": 0\n    },\n    \"data\": []\n  }\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 4 – Missing Date<\/h4>\n\n\n\n\n
Request<\/td>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/AttendanceLog?date_from=2026-09-01' \\\n--header 'Accept: application\/json' \\\n--header 'Authorization: Bearer <token>'<\/pre>\n<\/td>\n<\/tr>\n
400 Bad Request<\/td>\n\n
{\n  \"result\": false,\n  \"title\": \"Invalid Request\",\n  \"message\": \"date_to is required.\",\n  \"object\": null\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 5 – Invalid Date Range<\/h4>\n\n\n\n\n
Request<\/td>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/AttendanceLog?date_from=2026-09-30&date_to=2026-09-01' \\\n--header 'Accept: application\/json' \\\n--header 'Authorization: Bearer <token>'<\/pre>\n<\/td>\n<\/tr>\n
400 Bad Request<\/td>\n\n
{\n  \"result\": false,\n  \"title\": \"Invalid Request\",\n  \"message\": \"date_from must be earlier than or equal to date_to.\",\n  \"object\": null\n}<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Response Fields<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Field<\/th>\nType<\/th>\nNullable<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
employee_code<\/td>\nString<\/td>\nNo<\/td>\nEmployee code; leading zeros are significant.<\/td>\n<\/tr>\n
log_date_time<\/td>\nDateTime<\/td>\nNo<\/td>\nEffective log date\/time, YYYY-MM-DD HH:mm.<\/td>\n<\/tr>\n
collected_on<\/td>\nDateTime<\/td>\nNo<\/td>\nCollection\/receipt date\/time, YYYY-MM-DD HH:mm:ss.<\/td>\n<\/tr>\n
source<\/td>\nString<\/td>\nNo<\/td>\nAttendance log source.<\/td>\n<\/tr>\n
status<\/td>\nString<\/td>\nNo<\/td>\nCurrent processing status.<\/td>\n<\/tr>\n
direction<\/td>\nString<\/td>\nNo<\/td>\nPunch direction.<\/td>\n<\/tr>\n
device<\/td>\nObject<\/td>\nYes<\/td>\nDevice reference {id, label}.<\/td>\n<\/tr>\n
location<\/td>\nObject<\/td>\nYes<\/td>\nLocation reference {id, name}.<\/td>\n<\/tr>\n
coordinate<\/td>\nObject<\/td>\nYes<\/td>\nGPS coordinate {longitude, latitude}.<\/td>\n<\/tr>\n
notes<\/td>\nString<\/td>\nYes<\/td>\nLog notes.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Allowed Values<\/h4>\n\n\n\n\n\n\n\n
Field<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
source<\/td>\nDEVICE, IMPORT, MANUAL, GPS, APP<\/td>\n<\/tr>\n
status<\/td>\nPENDING, SKIPPED, PROCESSED, DISABLED, HOLD, SUSPECT<\/td>\n<\/tr>\n
direction<\/td>\nNA, IN, OUT<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Integration Notes<\/h4>\n
    \n
  • Both date parameters are required and inclusive; single-day requests are valid.<\/li>\n
  • Results are ordered by log_date_time ascending.<\/li>\n
  • Date\/time values use the configured modulus\u00ae account timezone.<\/li>\n
  • device, location, and coordinate can be null.<\/li>\n
  • Empty results return an empty data array with pagination metadata.<\/li>\n<\/ul>\n","protected":false},"featured_media":0,"parent":3773,"menu_order":2,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4771"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=4771"}],"version-history":[{"count":6,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4771\/revisions"}],"predecessor-version":[{"id":4790,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4771\/revisions\/4790"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3773"}],"next":[{"title":"API: List Employees","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/personnel-apis-v1\/api-list-employees\/","href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4778"}],"prev":[{"title":"API: List Attendance Devices","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/personnel-apis-v1\/api-list-attendance-devices\/","href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3453"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=4771"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4771"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}