Features supported

• Support asynchronous invocation: YES
• Supports paging: NO
• Field selection: NO
• Supplemental data: YES

AsyncSupplemental Data

curl --request GET \
  --url 'https://api.fareclock.com/shiftcards?from=2024-01-01&to=2024-01-31' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Query String

Name	Type	Required	Description
from	date	Yes	Start of date range for shift cards.
to	date	Yes	End of date range for shift cards.
employee	integer	No	Employee ID. If specified, orgUnit, department, and payClass are ignored.
orgUnit	integer	No	Organization unit ID of employee.
department	integer	No	Department ID.
payClass	integer	No	Pay class ID.
labels	integer	No	User or work label ID.
tag	string	No	Tag string filter.
userCustomFields	string	No	Custom fields query string.

{
  "results": [
    {
      "id": 1000,
      "modified": "2020-06-02T23:11:08.696838Z",
      "created": "2020-06-02T23:11:08.690835Z",
      "employee": 300,
      "employeeHourlyWage": null,
      "orgUnit": 100,
      "department": 200,
      "employeePayClass": 500,
      "shiftClass": 1100,
      "scheduleEvent": null,
      "scheduleShiftClass": null,
      "labels": [],
      "customFieldValues": [],
      "timezone": "America/New_York",
      "date": "2020-06-02",
      "shiftDate": "2020-06-02",
      "start": "2020-06-02T09:00:00Z",
      "end": "2020-06-02T17:00:00Z",
      "segments": [
        {
          "segment": ["2020-06-02T09:00:00Z", "2020-06-02T17:00:00Z"],
          "punch": 400,
          "tags": ["work"]
        }
      ],
      "punches": [
        {
          "id": 400,
          "in": "2020-06-02T09:00:00Z",
          "out": "2020-06-02T17:00:00Z",
          "inOrgUnit": 100,
          "outOrgUnit": 100,
          "inClock": 600,
          "outClock": 600,
          "inGeoAddress": "123 Main St",
          "outGeoAddress": "123 Main St",
          "inGeoFence": 900,
          "outGeoFence": 900,
          "inExceptions": [],
          "outExceptions": [],
          "status": "approved",
          "entryState": 50,
          "notes": "",
          "labels": [],
          "customFieldValues": [],
          "job": null,
          "jobPhase": null,
          "costCode": null,
          "processedTotal": 28800.0,
          "rawTotal": 28800.0,
          "lateDuration": 0.0,
          "inOrgUnitName": "Org Unit #1",
          "outOrgUnitName": "Org Unit #1",
          "inClockName": "Clock #1",
          "outClockName": "Clock #1",
          "labelNames": [],
          "timezone": "America/New_York",
          "employeePayrollId": "employee-payroll-id"
        }
      ],
      "timeOffEntries": [],
      "isTardy": false,
      "hasException": false,
      "hasFlagged": false,
      "breakTotal": 0.0,
      "regularPaid": 28800.0,
      "overtimePaid": 0.0,
      "unpaid": 0.0
    }
  ]
}