Shifts

Shift represense all periods scheduled for team member for requested day. On this page, we’ll dive into the different shifts endpoints you can use to work with your employees scheduled shifts. We'll look at how to get scheduled shifts.

The Shift model

The shift model contains the employeeID and array of scheduled periods for requested day.

Properties

Name
employeeID
Type
string
Description
Unique identifier of the team member.
Name
shifts
Type
Array<{ 'since': number, 'to': number }>
Description
The array of scheduled shifts.

GET/integrations/shifts

Get scheduled shifts

This endpoint allows you to get all scheduled shifts for the day. See the code examples for how to get your team members scheduled shifts through ProShedule API.

Required attributes

Name
businessDate
Type
Date (YYYY-MM-DD)
Description
A business date scheduled shifts is getting of.

Request

GET

/integrations/shifts

curl \
  --location "https://api.proschedule.ambraisoft.com/integrations/shifts?businessDate=2024-01-01" \
  --header "Authorization: Bearer {token}" \

Response

  [
    {
      "employeeID": "0c9cfa93-0e30-48fd-b6f2-a0025609f30b",
      "storeID": "74021106",
      "date": "2024-06-23",
      "isManager": true,
      "positionID": "9cdd40cb-935c-4c84-b553-0626273b6b7c",
      "startShiftPlan": "2024-06-23T15:00",
      "endShiftPlan": "2024-06-23T23:00",
      "startShiftFact": "2024-06-23T15:00",
      "endShiftFact": "2024-06-23T23:00"
    },
    {
      "employeeID": "0c9cfa93-0e30-48fd-b6f2-a0025777f30z",
      "storeID": "74021106",
      "date": "2024-06-23",
      "isManager": false,
      "positionID": "9cdd40cb-935c-4c84-b553-0626273b6b7c",
      "startShiftPlan": "2024-06-23T15:00",
      "endShiftPlan": "2024-06-23T23:00",
      "startShiftFact": "2024-06-23T15:00",
      "endShiftFact": "2024-06-23T23:00"
    }
  ]