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/clocklogs?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 clock log timestamp.
to	date	Yes	End of date range.
employee	integer	No	Employee ID.
clockOrgUnit	integer	No	Organization unit ID of clock/device.
workOrgUnit	integer	No	Organization unit ID of employee work location.
department	integer	No	Department ID.
status	string	No	Comma-separated values: punched, punch_attempted, approved, rejected, flagged, notapproved, notrejected, override, requires_action, face_requires_action, geo_enabled, geo_error, out_of_shift, tampered, offline.
clock	integer	No	Clock/device ID.
labels	string	No	Labels filter string (e.g. user:123 or work:123).
job	integer	No	Job ID.
userCustomFields	string	No	Custom fields query string.

{
  "results": [
    {
      "id": 800,
      "employee": 300,
      "employeeFirstName": "John",
      "employeeMiddleName": null,
      "employeeLastName": "Doe",
      "employeeDisplayName": "John Doe",
      "employeePayrollId": "employee-payroll-id",
      "clock": 600,
      "clockName": "Clock #1",
      "clockOrgUnit": 100,
      "clockOrgUnitName": "Organization Unit #1",
      "timezone": "America/New_York",
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "department": 200,
      "departmentName": "Department #1",
      "departmentPayrollId": "dept-1",
      "overrideBy": null,
      "job": null,
      "jobName": null,
      "jobPhase": null,
      "jobPhaseName": null,
      "costCode": null,
      "costCodeName": null,
      "labels": [],
      "labelNames": [],
      "faceLogId": null,
      "faceLog": null,
      "facePassiveLivenessResult": null,
      "geoFence": null,
      "geoFenceName": null,
      "geoFenceLat": null,
      "geoFenceLng": null,
      "geoFenceRange": null,
      "dt": "2020-06-02T09:00:00Z",
      "offline": false,
      "designatedForAction": true,
      "isPunched": true,
      "punchAttempted": true,
      "punchType": "in",
      "status": "approved",
      "tampered": false,
      "delegated": false,
      "outOfShift": false,
      "credentialingInvalid": false,
      "faceMode": "verify",
      "faceSuccess": true,
      "faceDetected": true,
      "facePending": false,
      "faceObjectLivenessFailed": null,
      "geoEnabled": false,
      "geoFenceEnabled": false,
      "geoError": null,
      "geoLat": null,
      "geoLng": null,
      "geoAccuracy": null,
      "geoAddress": null,
      "geoDelta": null,
      "geoDt": null,
      "created": "2020-06-02T09:00:00.123Z",
      "modified": "2020-06-02T09:00:00.123Z"
    }
  ]
}

curl --request GET \
  --url 'https://api.fareclock.com/clocklogs/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the clock log

{
  "results": [
    {
      "id": 800,
      "employee": 300,
      "employeeFirstName": "John",
      "employeeMiddleName": null,
      "employeeLastName": "Doe",
      "employeeDisplayName": "John Doe",
      "employeePayrollId": "employee-payroll-id",
      "clock": 600,
      "clockName": "Clock #1",
      "clockOrgUnit": 100,
      "clockOrgUnitName": "Organization Unit #1",
      "timezone": "America/New_York",
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "department": 200,
      "departmentName": "Department #1",
      "departmentPayrollId": "dept-1",
      "overrideBy": null,
      "job": null,
      "jobName": null,
      "jobPhase": null,
      "jobPhaseName": null,
      "costCode": null,
      "costCodeName": null,
      "labels": [],
      "labelNames": [],
      "faceLogId": null,
      "faceLog": null,
      "facePassiveLivenessResult": null,
      "geoFence": null,
      "geoFenceName": null,
      "geoFenceLat": null,
      "geoFenceLng": null,
      "geoFenceRange": null,
      "dt": "2020-06-02T09:00:00Z",
      "offline": false,
      "designatedForAction": true,
      "isPunched": true,
      "punchAttempted": true,
      "punchType": "in",
      "status": "approved",
      "tampered": false,
      "delegated": false,
      "outOfShift": false,
      "credentialingInvalid": false,
      "faceMode": "verify",
      "faceSuccess": true,
      "faceDetected": true,
      "facePending": false,
      "faceObjectLivenessFailed": null,
      "geoEnabled": false,
      "geoFenceEnabled": false,
      "geoError": null,
      "geoLat": null,
      "geoLng": null,
      "geoAccuracy": null,
      "geoAddress": null,
      "geoDelta": null,
      "geoDt": null,
      "created": "2020-06-02T09:00:00.123Z",
      "modified": "2020-06-02T09:00:00.123Z"
    }
  ]
}