{"id":4558,"date":"2025-11-11T17:55:55","date_gmt":"2025-11-11T15:55:55","guid":{"rendered":"https:\/\/modulus.help\/kb\/?post_type=docs&p=4558"},"modified":"2025-11-17T11:49:22","modified_gmt":"2025-11-17T09:49:22","slug":"api-list-employee-schedules","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/personnel-apis-v1\/api-list-employee-schedules\/","title":{"rendered":"API: List Employee Schedules"},"content":{"rendered":"

The purpose of this API is to retrieve employee schedules within a specified date range, with optional filters.<\/p>\n

Request<\/h4>\n\n\n\n\n\n\n\n\n
API Name<\/th>\nSchedule<\/td>\n<\/tr>\n
URL<\/th>\n\n https:\/\/your_account.modulus.biz\/api\/hr\/v1\/Schedule<\/td>\n<\/tr>\n
Method<\/th>\nGET<\/td>\n<\/tr>\n
Source<\/th>\nThird Party Server<\/td>\n<\/tr>\n
Recipient<\/th>\nmodulus\u00ae Server<\/td>\n<\/tr>\n
Content Type<\/th>\napplication\/json<\/td>\n<\/tr>\n
Accept<\/th>\napplication\/json<\/td>\n<\/tr>\n<\/table>\n

Request Headers<\/h4>\n\n\n\n
Header<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n
Authorization<\/td>\nYes<\/td>\nBearer token for authentication.
\nFormat: Bearer <token><\/td>\n<\/tr>\n<\/table>\n

Query String Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter<\/th>\nRequired<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
date_from<\/td>\nYes<\/td>\nDate<\/td>\nStart date in format YYYY-MM-DD.<\/td>\n<\/tr>\n
date_to<\/td>\nYes<\/td>\nDate<\/td>\nEnd date in format YYYY-MM-DD. Must be later than date_from.<\/td>\n<\/tr>\n
employee_code<\/td>\nNo<\/td>\nNumber<\/td>\nRestricts result to a specific employee.<\/td>\n<\/tr>\n
has_punch<\/td>\nNo<\/td>\nBoolean<\/td>\nSet to 1 to include only employees who have punch-in\/out records.<\/td>\n<\/tr>\n
include_schedule<\/td>\nNo<\/td>\nBoolean<\/td>\nIf 1, includes full schedule details for each employee.<\/td>\n<\/tr>\n
min_expected_minutes<\/td>\nNo<\/td>\nNumber<\/td>\nFilters employees with expected working minutes above this value.<\/td>\n<\/tr>\n
max_expected_minutes<\/td>\nNo<\/td>\nNumber<\/td>\nFilters employees with expected working minutes below this value.<\/td>\n<\/tr>\n
page_number<\/td>\nNo<\/td>\nNumber<\/td>\nPage number of the result set. Default = 1.<\/td>\n<\/tr>\n
page_size<\/td>\nNo<\/td>\nNumber<\/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
\n Success Responses<\/td>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nSchedules listed successfully.<\/td>\n\n
{\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    \"department_name\": \"QA\/QC\",\n    \"location_name\": \"Cairo HQ\",\n    \"position_name\": \"Manager QC\",\n    \"schedules\": [\n      {\n        \"date\": \"2025-01-05\",\n        \"attended_from\": \"2025-01-05 09:00\",\n        \"attended_to\": \"2025-01-05 17:00\",\n        \"expected_from\": \"2025-01-05 09:00\",\n        \"expected_to\": \"2025-01-05 17:00\",\n        \"shift_nature\": \"Attended\"\n      }\n    ]\n  }\n]\n}<\/pre>\n<\/td>\n<\/tr>\n
\n Failure Responses<\/td>\n<\/tr>\n
400 Bad Request<\/td>\nfalse<\/td>\nError<\/td>\nX is required.<\/td>\nnull<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example 1<\/h4>\n\n\n\n\n
\n Request<\/td>\n\n
\ncurl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/Schedule?date_from=2025-01-01&date_to=2025-01-02&include_schedule=1' \\\n--header 'Accept: application\/json' \\\n--header 'Content-Type: application\/json' \\\n--header 'Authorization: Bearer y78hewy2387898978732814jewjkj32u489u'\n<\/pre>\n<\/td>\n<\/tr>\n
\n 200 OK<\/td>\n\n
\n{\n\"result\": true,\n\"title\": \"Success\",\n\"message\": \"Schedules 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      \"department_name\": \"QA\/QC\",\n      \"location_name\": \"Cairo HQ\",\n      \"position_name\": \"Manager QC\",\n      \"schedules\": [\n        {\n          \"date\": \"2025-01-01\",\n          \"attended_from\": \"2025-01-01 09:00\",\n          \"attended_to\": \"2025-01-01 17:00\",\n          \"expected_from\": \"2025-01-01 09:00\",\n          \"expected_to\": \"2025-01-01 17:00\",\n          \"shift_nature\": \"Attended\"\n        }\n      ]\n    }\n  ]\n}\n}\n<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 2<\/h4>\n\n\n\n\n
\n        Request<\/td>\n\n
\ncurl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/Schedule?date_from=2025-01-01&date_to=2025-01-02&include_schedule=1&page_number=2' \\\n--header 'Accept: application\/json' \\\n--header 'Content-Type: application\/json' \\\n--header 'Authorization: Bearer y78hewy2387898978732814jewjkj32u489u'\n<\/pre>\n<\/td>\n<\/tr>\n
\n        200 OK<\/td>\n\n
\n{\n\"result\": true,\n\"title\": \"Success\",\n\"message\": \"No data found match your conditions.\",\n\"object\": null\n}\n<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Example 3<\/h4>\n\n\n\n\n
\n        Request<\/td>\n\n
\ncurl --request GET 'https:\/\/your_account.modulus.biz\/api\/hr\/v1\/Schedule?date_from=2025-01-01' \\\n--header 'Accept: application\/json' \\\n--header 'Content-Type: application\/json' \\\n--header 'Authorization: Bearer y78hewy2387898978732814jewjkj32u489u'\n<\/pre>\n<\/td>\n<\/tr>\n
\n        400 Bad Request<\/td>\n\n
\n{\n\"result\": false,\n\"title\": \"Error\",\n\"message\": \"date_to is required\",\n\"object\": null\n}\n<\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\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\/4558"}],"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=4558"}],"version-history":[{"count":3,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4558\/revisions"}],"predecessor-version":[{"id":4583,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4558\/revisions\/4583"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/3773"}],"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=4558"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4558"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}