Features supported

• Support asynchronous invocation: NO
• Supports paging: YES, with results ordered by job name
• Field selection: NO
• Supplemental data: YES

PagingSupplemental Data

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

Query String

Name	Type	Required	Description
id	integer	No	Numeric ID of the job
active	string	No	Allowed values: active or inactive
search	string	No	Case-insensitive full text search of job name
labels	integer	No	Work label ID
orgUser	integer	No	Employee ID
orderBy	string	No	Allowed values: name (default) or modified

{
  "results": [
    {
      "id": 1,
      "name": "Job #1",
      "active": true,
      "description": "Building construction work",
      "payrollId": "job-1-payroll-id",
      "orgUsers": [],
      "notifyOrgUsers": [],
      "allowLabels": ["device:all", "user:all"],
      "labels": [],
      "jobPhaseMode": null,
      "costCodeMode": null,
      "inGeoRules": [],
      "outGeoRules": [],
      "bgGeoRules": [],
      "enableShiftSchedule": false,
      "briefings": [],
      "credentialTypes": [],
      "forms": [],
      "created": "2014-01-01T18:53:46.016Z",
      "modified": "2014-01-03T12:44:17.935Z"
    }
  ]
}

curl --request POST \
  --url 'https://api.fareclock.com/jobs' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Job #1",
  "active": true,
  "description": "Building construction work",
  "payrollId": "job-1-payroll-id",
  "allowLabels": [
    "device:all",
    "user:all"
  ],
  "jobPhaseMode": "enable",
  "costCodeMode": "enable",
  "enableShiftSchedule": false
}'

{
  "name": "Job #1",
  "active": true,
  "description": "Building construction work",
  "payrollId": "job-1-payroll-id",
  "allowLabels": ["device:all", "user:all"],
  "jobPhaseMode": "enable",
  "costCodeMode": "enable",
  "enableShiftSchedule": false
}

{
  "results": [
    {
      "id": 1,
      "name": "Job #1",
      "active": true,
      "description": "Building construction work",
      "payrollId": "job-1-payroll-id",
      "orgUsers": [],
      "notifyOrgUsers": [],
      "allowLabels": ["device:all", "user:all"],
      "labels": [],
      "jobPhaseMode": "enable",
      "costCodeMode": "enable",
      "inGeoRules": [],
      "outGeoRules": [],
      "bgGeoRules": [],
      "enableShiftSchedule": false,
      "briefings": [],
      "credentialTypes": [],
      "forms": [],
      "created": "2014-01-01T18:53:46.016Z",
      "modified": "2014-01-03T12:44:17.935Z"
    }
  ]
}

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

Path

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

{
  "results": [
    {
      "id": 1,
      "name": "Job #1",
      "active": true,
      "description": "Building construction work",
      "payrollId": "job-1-payroll-id",
      "orgUsers": [],
      "notifyOrgUsers": [],
      "allowLabels": ["device:all", "user:all"],
      "labels": [],
      "jobPhaseMode": "enable",
      "costCodeMode": "enable",
      "inGeoRules": [],
      "outGeoRules": [],
      "bgGeoRules": [],
      "enableShiftSchedule": false,
      "briefings": [],
      "credentialTypes": [],
      "forms": [],
      "created": "2014-01-01T18:53:46.016Z",
      "modified": "2014-01-03T12:44:17.935Z"
    }
  ]
}

curl --request PUT \
  --url 'https://api.fareclock.com/jobs/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Job #1",
  "active": true,
  "description": "Building construction work",
  "payrollId": "job-1-payroll-id",
  "allowLabels": [
    "device:all",
    "user:all"
  ],
  "jobPhaseMode": "enable",
  "costCodeMode": "enable",
  "enableShiftSchedule": false
}'

Path

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

{
  "name": "Job #1",
  "active": true,
  "description": "Building construction work",
  "payrollId": "job-1-payroll-id",
  "allowLabels": ["device:all", "user:all"],
  "jobPhaseMode": "enable",
  "costCodeMode": "enable",
  "enableShiftSchedule": false
}

{
  "results": [
    {
      "id": 1,
      "name": "Job #1",
      "active": true,
      "description": "Building construction work",
      "payrollId": "job-1-payroll-id",
      "orgUsers": [],
      "notifyOrgUsers": [],
      "allowLabels": ["device:all", "user:all"],
      "labels": [],
      "jobPhaseMode": "enable",
      "costCodeMode": "enable",
      "inGeoRules": [],
      "outGeoRules": [],
      "bgGeoRules": [],
      "enableShiftSchedule": false,
      "briefings": [],
      "credentialTypes": [],
      "forms": [],
      "created": "2014-01-01T18:53:46.016Z",
      "modified": "2014-01-03T12:44:17.935Z"
    }
  ]
}