getEmployeesByPageV1
Get Employees By Page
Query parameters
Include Audits to retrieve (optional)
Include Locations (All,True,False) to retrieve (optional)
Include Positions to retrieve (optional)
Include Terminated to retrieve (optional)
The Code that identifies the Location in Crunchtime.
The number of minutes since an employee record was last updated. Use to set how far back to search. (optional).
Retrieve one or more records by pageNumber. Use to retrieve data in smaller chunks. If left blank, the default is 10.
Number of items to display per page.
Earliest date in search range (optional). Format: yyyy-MM-dd'T'HH:mm:ss
Latest date in search range (optional). Format: yyyy-MM-dd'T'HH:mm:ss
Specify 'true' to output null data elements.
Headers
Secure token for API authentication.
Password for the Crunchtime Application User.
Crunchtime site identifier. (test or production)
User ID for the Crunchtime Application User.
Optional trace identifier for troubleshooting.
Response
Success
Example response
{
"employeeDetails": [
{
"address1": "200 Main Street",
"age": 29,
"breakWaiver": "Y",
"broadcastSchedule": "Y",
"city": "Anywhere",
"country": "USA",
"createUser": 10000003,
"dateCreate": "04/17/2012",
"dateEdit": "11/30/2016",
"dateEditUtc": "2021-08-12T10:21:46",
"dateHired": "02/01/2012",
"dateOfBirth": "07/30/1991",
"dateTerminated": "12/31/9999",
"editUser": 10000001,
"employeeAudits": [
{
"auditDate": "2015-06-19T17:34:36",
"changeType": "E",
"changeValue": "LABOR AUTOMATION THREE",
"editValue": "N",
"fieldName": "NC Changed Employee",
"id": 388777,
"originalValue": "Y",
"sectionName": "Employee",
"userFirstName": "John",
"userId": "IM_OWNER",
"userLastName": "Doe",
"valueDataType": "C"
}
],
"employeeLocations": [
{
"activeFlag": "Y",
"allocateLaborTo": "N",
"deleteFlag": "N",
"id": 17,
"locationCityName": "Anywhere",
"locationName": "AUTOMATION THREE",
"locationStateName": "MASSACHUSETTS",
"primaryLocationFlag": true
}
],
"employeeNumber": "AUTO-0000000004",
"employeePositions": [
{
"deleteFlag": "N"
}
],
"federalMaritalStatus": "SINGLE",
"firstName": "John",
"lastName": "Doe",
"locationName": "AUTOMATION THREE",
"manager": "Y",
"middleName": "Middle",
"partTime": "Y",
"payType": "H",
"payrollIdNumber": "0000000004",
"postalCode": "01234",
"primaryPositionName": "DINING ROOM SERVER (GT)",
"sex": "F",
"stateMaritalStatus": "SINGLE",
"stateProvince": "MA",
"status": "Leave",
"statusCode": "Terminated"
}
],
"hasNext": true,
"totalPages": 10
}