Features supported

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

Paging

curl --request GET \
  --url 'https://api.fareclock.com/employees?id=123&employee=example&orgUnit=123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Query String

Name	Type	Required	Description
id	integer	No	Numeric ID of the employee
employee	string	No	Case-insensitive full text search of employee name
orgUnit	integer	No	Organization unit ID
department	integer	No	Department ID
payClass	integer	No	Pay class ID
labels	integer	No	User label ID
active	string	No	Allowed values: active or inactive
credentialPolicy	integer	No	Credential policy ID
credentialType	integer	No	Credential type ID
credentialValid	string	No	Allowed values: valid, invalid, or all
hasFaceModel	string	No	Allowed values: yes or no
requireJobAccess	string	No	Allowed values: yes or no
orderBy	string	No	Allowed values: name (default) or modified
from	date	No	Start of date range for modification timestamp. Only when orderBy=modified.
to	date	No	End of date range for modification timestamp. Only when orderBy=modified.

{
  "results": [
    {
      "id": 300,
      "active": true,
      "roles": ["worker"],
      "firstName": "John",
      "lastName": "Doe",
      "middleName": null,
      "displayName": "John Doe",
      "sortName": "doe, john",
      "accepted": false,
      "permissions": [],
      "notifications": ["clock_alerts"],
      "lastAccess": null,
      "banned": false,
      "workerAllowLabels": [],
      "adminAllowLabels": [],
      "requireJobAccess": false,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "orgUnitPayrollId": null,
      "timezone": "America/New_York",
      "department": 200,
      "departmentName": "Department #1",
      "departmentPayrollId": null,
      "teamSchedule": null,
      "teamScheduleName": null,
      "payClass": 500,
      "payClassName": "Regular Hourly",
      "timeOffPolicy": null,
      "disciplinePolicy": null,
      "pointBalance": null,
      "nextShiftReminder": null,
      "pin": "123456",
      "qrCode": null,
      "nfcTagId": null,
      "payrollId": null,
      "neverHadFace": false,
      "lastPunch": "2014-04-03T17:28:24.326Z",
      "hasDocuments": false,
      "hasCredentials": false,
      "credentialPolicy": null,
      "credentialPolicyName": null,
      "invalidCredentialing": false,
      "inducted": false,
      "contactSuppressions": null,
      "announcement": null,
      "announcementOverride": false,
      "personalDeviceMode": null,
      "personalAuthPunchOnly": false,
      "personalAdminPerms": [],
      "reinstallPerm": null,
      "geoRules": [],
      "mobilePhone": null,
      "installCode": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixCostingIsPartial": false,
      "bgGeoConnectionState": null,
      "address": null,
      "addressGeoCode": null,
      "phones": [],
      "email": null,
      "gender": null,
      "birthDate": null,
      "nationalId": null,
      "nationalIdKey": null,
      "driversLic": null,
      "driversLicExpDate": null,
      "passportNo": null,
      "passportExpDate": null,
      "nationality": null,
      "hireDate": null,
      "hireBy": null,
      "jobTitle": null,
      "termDate": null,
      "hirePeriods": [],
      "payRates": [],
      "bankInfo": {},
      "notes": null,
      "emgContact": null,
      "emgRelation": null,
      "emgPhones": [],
      "emgEmail": null,
      "emgAddress": null,
      "distributor": null,
      "customFieldValues": [],
      "created": "2013-12-06T20:38:21.347Z",
      "modified": "2014-04-03T17:28:24.326Z"
    }
  ]
}

curl --request POST \
  --url 'https://api.fareclock.com/employees' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true,
  "firstName": "John",
  "lastName": "Doe",
  "orgUnit": 100,
  "department": 200,
  "payrollId": null,
  "pin": "123456",
  "allowAllOrgUnits": true,
  "phones": [],
  "email": null,
  "notes": null
}'

{
  "active": true,
  "firstName": "John",
  "lastName": "Doe",
  "orgUnit": 100,
  "department": 200,
  "payrollId": null,
  "pin": "123456",
  "allowAllOrgUnits": true,
  "phones": [],
  "email": null,
  "notes": null
}

{
  "results": [
    {
      "id": 300,
      "active": true,
      "firstName": "John",
      "lastName": "Doe",
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "department": 200,
      "departmentName": "Department #1",
      "timezone": "America/New_York",
      "payrollId": null,
      "created": "2013-12-06T20:38:21.347Z",
      "modified": "2013-12-06T20:38:21.347Z"
    }
  ]
}

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

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the employee

{
  "results": [
    {
      "id": 300,
      "active": true,
      "roles": ["worker"],
      "firstName": "John",
      "lastName": "Doe",
      "middleName": null,
      "displayName": "John Doe",
      "sortName": "doe, john",
      "accepted": false,
      "permissions": [],
      "notifications": ["clock_alerts"],
      "lastAccess": null,
      "banned": false,
      "workerAllowLabels": [],
      "adminAllowLabels": [],
      "requireJobAccess": false,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "orgUnitPayrollId": null,
      "timezone": "America/New_York",
      "department": 200,
      "departmentName": "Department #1",
      "departmentPayrollId": null,
      "teamSchedule": null,
      "teamScheduleName": null,
      "payClass": 500,
      "payClassName": "Regular Hourly",
      "timeOffPolicy": null,
      "disciplinePolicy": null,
      "pointBalance": null,
      "nextShiftReminder": null,
      "pin": "123456",
      "qrCode": null,
      "nfcTagId": null,
      "payrollId": null,
      "neverHadFace": false,
      "lastPunch": "2014-04-03T17:28:24.326Z",
      "hasDocuments": false,
      "hasCredentials": false,
      "credentialPolicy": null,
      "credentialPolicyName": null,
      "invalidCredentialing": false,
      "inducted": false,
      "contactSuppressions": null,
      "announcement": null,
      "announcementOverride": false,
      "personalDeviceMode": null,
      "personalAuthPunchOnly": false,
      "personalAdminPerms": [],
      "reinstallPerm": null,
      "geoRules": [],
      "mobilePhone": null,
      "installCode": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixCostingIsPartial": false,
      "bgGeoConnectionState": null,
      "address": null,
      "addressGeoCode": null,
      "phones": [],
      "email": null,
      "gender": null,
      "birthDate": null,
      "nationalId": null,
      "nationalIdKey": null,
      "driversLic": null,
      "driversLicExpDate": null,
      "passportNo": null,
      "passportExpDate": null,
      "nationality": null,
      "hireDate": null,
      "hireBy": null,
      "jobTitle": null,
      "termDate": null,
      "hirePeriods": [],
      "payRates": [],
      "bankInfo": {},
      "notes": null,
      "emgContact": null,
      "emgRelation": null,
      "emgPhones": [],
      "emgEmail": null,
      "emgAddress": null,
      "distributor": null,
      "customFieldValues": [],
      "created": "2013-12-06T20:38:21.347Z",
      "modified": "2014-04-03T17:28:24.326Z"
    }
  ]
}

The API does not allow updating an employee from inactive to active state.

curl --request PUT \
  --url 'https://api.fareclock.com/employees/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 300,
  "active": true,
  "firstName": "John",
  "lastName": "Doe",
  "orgUnit": 100,
  "department": 200,
  "payrollId": null,
  "pin": "123456",
  "phones": [],
  "notes": null
}'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the employee

{
  "id": 300,
  "active": true,
  "firstName": "John",
  "lastName": "Doe",
  "orgUnit": 100,
  "department": 200,
  "payrollId": null,
  "pin": "123456",
  "phones": [],
  "notes": null
}

{
  "results": [
    {
      "id": 300,
      "active": true,
      "roles": ["worker"],
      "firstName": "John",
      "lastName": "Doe",
      "middleName": null,
      "displayName": "John Doe",
      "sortName": "doe, john",
      "accepted": false,
      "permissions": [],
      "notifications": ["clock_alerts"],
      "lastAccess": null,
      "banned": false,
      "workerAllowLabels": [],
      "adminAllowLabels": [],
      "requireJobAccess": false,
      "orgUnit": 100,
      "orgUnitName": "Organization Unit #1",
      "orgUnitPayrollId": null,
      "timezone": "America/New_York",
      "department": 200,
      "departmentName": "Department #1",
      "departmentPayrollId": null,
      "teamSchedule": null,
      "teamScheduleName": null,
      "payClass": 500,
      "payClassName": "Regular Hourly",
      "timeOffPolicy": null,
      "disciplinePolicy": null,
      "pointBalance": null,
      "nextShiftReminder": null,
      "pin": "123456",
      "qrCode": null,
      "nfcTagId": null,
      "payrollId": null,
      "neverHadFace": false,
      "lastPunch": "2014-04-03T17:28:24.326Z",
      "hasDocuments": false,
      "hasCredentials": false,
      "credentialPolicy": null,
      "credentialPolicyName": null,
      "invalidCredentialing": false,
      "inducted": false,
      "contactSuppressions": null,
      "announcement": null,
      "announcementOverride": false,
      "personalDeviceMode": null,
      "personalAuthPunchOnly": false,
      "personalAdminPerms": [],
      "reinstallPerm": null,
      "geoRules": [],
      "mobilePhone": null,
      "installCode": null,
      "fixJob": null,
      "fixJobLabel": null,
      "fixJobPhase": null,
      "fixCostCode": null,
      "fixCostingIsPartial": false,
      "bgGeoConnectionState": null,
      "address": null,
      "addressGeoCode": null,
      "phones": [],
      "email": null,
      "gender": null,
      "birthDate": null,
      "nationalId": null,
      "nationalIdKey": null,
      "driversLic": null,
      "driversLicExpDate": null,
      "passportNo": null,
      "passportExpDate": null,
      "nationality": null,
      "hireDate": null,
      "hireBy": null,
      "jobTitle": null,
      "termDate": null,
      "hirePeriods": [],
      "payRates": [],
      "bankInfo": {},
      "notes": null,
      "emgContact": null,
      "emgRelation": null,
      "emgPhones": [],
      "emgEmail": null,
      "emgAddress": null,
      "distributor": null,
      "customFieldValues": [],
      "created": "2013-12-06T20:38:21.347Z",
      "modified": "2014-04-03T17:28:24.326Z"
    }
  ]
}

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

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the employee