Documentation

Shifts

Read shift master data for scheduling integrations.

Requires scope: shifts

Endpoints

GET/api/v1/integrations/shiftsBearer auth

List shifts

Query: isActive

Example response

{
  "success": true,
  "status": 200,
  "data": {
    "shifts": [
      {
        "id": "665f1a2b3c4d5e6f7a8b9c77",
        "name": "General Shift",
        "startTime": "09:30",
        "endTime": "18:30",
        "shiftType": "fixed",
        "breakDuration": 60,
        "isOvernight": false,
        "isActive": true,
        "assignedEmployees": 12
      }
    ]
  }
}

GET/api/v1/integrations/shifts/:idBearer auth

Get one shift

Example response

{
  "success": true,
  "status": 200,
  "data": {
    "shift": {
      "id": "665f1a2b3c4d5e6f7a8b9c77",
      "name": "General Shift",
      "startTime": "09:30",
      "endTime": "18:30",
      "shiftType": "fixed",
      "breakDuration": 60,
      "isOvernight": false,
      "isActive": true,
      "assignedEmployees": 12
    }
  }
}