Shifts

Returns upcoming or unassigned shifts

Get employee upcoming or unassigned shifts, starting from today

get/users/shifts

Request

Base URL
https://user-api.quinyx.com/v2
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/quinyx/apis/quinyx-user-api/docs/users/shifts/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

filter'upcoming' | 'unassigned' required

Choose upcoming or unassigned shifts

Response

All shifts are sorted by the start time in ascending order (limited to 20 shifts, in published period, up to 90 days in the future)

Example response

{
  "shifts": [
    {
      "id": "fQRK0r5s9S4dXwRa_u5vjIKfHzBhzO9wpCjJ583dRX6.oxr63g--",
      "employeeName": "John Doe",
      "from": "2019-02-01 09:00:00",
      "to": "2019-02-01 17:00:00",
      "shiftType": "Day Shift",
      "unit": "Unit name",
      "section": "Section name",
      "breaksDuration": 60,
      "breaks": [
        {
          "start": "2019-02-01 11:30:00",
          "end": "2019-02-01 12:30:00"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.