Field Operations

timeClock

3 endpoints. Start at search to collect IDs, then resolve them through get.

Read · 3

Read operations

search/timeClock/searchTry it

search timeClock

Provide a set of parameters which will return a list of ids. There is no limit to the number of IDs this will return. You can then supply these ids to the get endpoint in order to retrieve bulk data. Every parameter available supports a simple value OR a powerful query object that gives you access to all basic comparators.

Example

dateAdded={"operator":">","value":"2016-01-01"}

Example

dateAdded={"operator\":\"BETWEEN\",\"value\":[\"2016-05-12\",\"2016-05-13\"]}

Available operators

><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINS

Each of the search endpoints allows for an optional parameter 'includeData'. When sent, the API will additionally send the resolved objects for the first 1000 IDs.

Keep in mind when using 'includeData' that if there are more than 1000 items an additional property '{entity}IDsNoDataExported' will specify the items that are not included in the resolved data array.

Parameters

entryIDsinteger

Primary key.

timeClockIDsinteger

Primary key (alias)

officeIDsinteger

No description in the upstream reference.

employeeIDsinteger

EmployeeID who the time clock entry applies to.

timeInstring

Clock-in time

timeOutstring

Clock-out time

paidinteger

0 for unpaid categories, 1 for paid categories. Clock entries with no category association are considered paid.

includeDatainteger

{0,1} Sends the resolved objects for the first 1000 IDs. If there are more than 1000 items an additional property timeClockIDsNoDataExported will specify the items that are not included in the resolved timeClock array.

Returns

timeClockIDsarray

No description in the upstream reference.

Request

/timeClock/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/timeClock/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'entryIDs=1' \
  --data-urlencode 'timeClockIDs=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

0:10000

1:10007

2:10014

3:10021

4:10028

5:10035

6:10042

7:10049

]

count:8

}

get/timeClock/getTry it

get timeClock

Get Bulk data for timeClock. Accepts an array of entryIDs. Returns a max of 1000 records.

Parameters

entryIDsarray

No description in the upstream reference.

Returns

entryIDinteger

Unique ID

employeeIDinteger

EmployeeID time clock entry applied to

officeIDinteger

officeID the time clock entry was made on

timeInstring

Clock-in time in server time (PST)

timeOutstring

Clock-Out time in server time (PST)

clockCategoryIDinteger

Clock category ID that was used for this entry

paidinteger

0 - time clock category is specified as unpaid, 1 - time clock category is specified as paid. If time clock category is specified as 0 or does not exist it is considered a paid entry.

Request

/timeClock/get

curl -X POST 'https://{subdomain}.pestroutes.com/api/timeClock/get' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'entryIDs=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

]

count:2

}

by id/timeClock/{id}Try it

Fetch by id timeClock

Get timeClock data for single ID -- please provide a specific record ID in the URL structure.

Parameters

No parameters beyond authentication.

Returns

entryIDinteger

Unique ID

employeeIDinteger

EmployeeID time clock entry applied to

officeIDinteger

officeID the time clock entry was made on

timeInstring

Clock-in time in server time (PST)

timeOutstring

Clock-Out time in server time (PST)

clockCategoryIDinteger

Clock category ID that was used for this entry

paidinteger

0 - time clock category is specified as unpaid, 1 - time clock category is specified as paid. If time clock category is specified as 0 or does not exist it is considered a paid entry.

Request

/timeClock/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/timeClock/{id}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

entryID:6624

employeeID:5916

officeID:2602

timeIn:"2026-03-27 00:00:00"

timeOut:"2026-01-05 00:00:00"

clockCategoryID:5626

paid:2175

}