List Staff Schedules | SalaryBox

{
  "message": "Success",
  "status": true,
  "data": [
    {
      "salarybox_id": "SBK7Q2M9TX",
      "employee_id": "EMP-0042",
      "name": "Aarav Sharma",
      "branches": [
        "Bengaluru HQ"
      ],
      "departments": [
        "Sales"
      ],
      "schedule_type": "fixed",
      "days": [
        {
          "date": "2026-11-05",
          "is_day_off": false,
          "shifts": [
            {
              "name": "General Shift",
              "start_time": "09:30:00",
              "end_time": "18:30:00"
            }
          ]
        },
        {
          "date": "2026-11-06",
          "is_day_off": false,
          "shifts": [
            {
              "name": "General Shift",
              "start_time": "09:30:00",
              "end_time": "18:30:00"
            }
          ]
        },
        {
          "date": "2026-11-07",
          "is_day_off": true,
          "shifts": []
        }
      ]
    },
    {
      "salarybox_id": "SBH2W7C4ZN",
      "employee_id": "EMP-0071",
      "name": "Imran Qureshi",
      "branches": [
        "Pune Plant"
      ],
      "departments": [
        "Production"
      ],
      "schedule_type": "flexible",
      "days": [
        {
          "date": "2026-11-05",
          "is_day_off": false,
          "shifts": [
            {
              "name": "Night Shift",
              "start_time": "22:00:00",
              "end_time": "06:00:00"
            }
          ]
        },
        {
          "date": "2026-11-06",
          "is_day_off": false,
          "shifts": [
            {
              "name": "Morning Split",
              "start_time": "06:00:00",
              "end_time": "10:00:00"
            },
            {
              "name": "Evening Split",
              "start_time": "17:00:00",
              "end_time": "21:00:00"
            }
          ]
        },
        {
          "date": "2026-11-07",
          "is_day_off": false,
          "shifts": []
        }
      ]
    },
    {
      "salarybox_id": "SBT5L9Q3MV",
      "employee_id": null,
      "name": "Kavya Reddy",
      "branches": [],
      "departments": [],
      "schedule_type": null,
      "days": [
        {
          "date": "2026-11-05",
          "is_day_off": false,
          "shifts": []
        },
        {
          "date": "2026-11-06",
          "is_day_off": false,
          "shifts": []
        },
        {
          "date": "2026-11-07",
          "is_day_off": false,
          "shifts": []
        }
      ]
    }
  ],
  "count": 3,
  "prev": null,
  "next": null
}

Returns each staff member’s planned schedule for every date in a range of up to 60 days (future dates allowed): whether the date is a day off and which shifts are planned. This is the plan, not what happened.

schedule_type is:

fixed: a weekly pattern, optionally only on certain weeks of the month (for example “2nd and 4th Saturday off”).
flexible: a roster set date by date. Unrostered dates have no shifts.
standard: an older weekly pattern (shown as fixed in the app) where date-specific changes override the week.
null: no schedule; every date has no shifts.

A date can have several shifts (split shifts). A shift whose end_time is before its start_time ends the next day. Holidays and leaves are not part of the schedule.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

start_datedateRequired

First day, YYYY-MM-DD.

end_datedateRequired

Last day, YYYY-MM-DD. The range can cover at most 60 days.

salarybox_idslist of stringsOptional

Repeatable. Limits the result to these staff members, for example salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP.

branch_nameslist of stringsOptional

Repeatable. Exact branch names (case-sensitive).

department_nameslist of stringsOptional

Repeatable. Exact department names (case-sensitive).

pageintegerOptional

Page number, starting at 1.

page_sizeintegerOptional

Results per page. Default and maximum 500.

Response

One entry per matching staff member on this page.

messagestring

statusboolean

datalist of objects

countinteger

Total number of matching staff members across all pages.

prevstring or null

URL of the previous page, or null on the first page.

nextstring or null

URL of the next page, or null on the last page.

Errors

400

Bad Request Error

404

Not Found Error