Shift Schedules API

August 28, 2025

NoahFace enables workers to view their upcoming work schedule. To support this, you simply implement our Shift Schedule API (a REST Web Hook), and configure NoahFace to call it.

Shift Schedules API

The Shift Schedules API uses the same endpoint as a the User Synchronization API, with additional query parameters appended.

Query Paramaters

In detail, requests for shifts will have the following additional query paramaters:

type. A type of "shift" indicates that a list of shifts should be returned (instead of a list of users).
syncguid. The unique identifier of the user.
from. The start of the date range of shifts to be returned, in the form: YYYY-MM-DD.
to. The end of the date range of shifts to be returned, in the form: YYYY-MM-DD.

‍

So, the logic within your implementation of this endpoint should be as follows:

if (the query parameter type is present) {
    if (type=shift) {
        return shift information for user
    } else if (type=leave) {
        return leave information for user
    } else ...
else {
    return user information for all users
}

‍

Returned Data

On success you should return a status code of 200 and JSON data with a top level element called shifts containing the list of shifts for the specified user over the specified date range.

Each shift should contain the following elements (only the first three are required):

id. A unique identifier for the shift.
from. The start date and time for the shift, in the form: YYYY-MM-DD HH:MM.
to. The end date and time for the shift, in the form: YYYY-MM-DD HH:MM.
position. The specific position assigned to the shift.
site. The specific site assigned to the shift.
notes. Any notes associated with the shift.

For example:

{
   "shifts": [
     {
         "id": "1001", 
         "from": "2025-08-01 08:30", 
         "to": "2025-08-01 17:00", 
         "position":"Customer Service", 
         "site":"Chicago",
         "notes": "Please cover for Max."
     },
     {
         "id": "1002", 
         "from": "2025-08-03 22:30", 
         "to": "2025-08-04 05:00"
     }
   ]
}

‍

On failure you should return a status code other than 200 and any additional error details as follows:

{
    “errorCode”: “X12345”,
    “errorMsg”: “Shift schedule nout available”
}

‍

Configuration

To learn how to configure NoahFace to display shift schedules, see: Self Service.

‍