TimeWellScheduled - Employee Scheduling Software Logo

Platform       Solutions       Pricing

Contact Us
Employee Login

Workforce Management

Scheduling

Create and share schedules in minutes. Reduce overstaffing and ensure you always have the right people on the floor.

Absences & Availability

Stop the back-and-forth. Track time-off requests and employee availability in one centralized calendar.

t

Who’s Working Board

Get a real-time snapshot of your entire operation. Instantly see who is clocked in, who’s late, and who’s on break.

Time & Attendance

}

Punch Clock

Secure, user-friendly options to eliminate time theft and human error. Support for web, mobile, and biometric hardware.

Time Cards

Automated digital time cards that simplify approvals. Spend less time chasing paper and more time growing your business.

Payroll Integration

Push accurate data to your payroll provider in clicks, not hours. We play nice with the platforms you already use.

Employee Engagement

Team Communication

Keep everyone in the loop with secure group chats and direct messaging. No more missed texts or messy email chains.

Company News Board

A digital hub for announcements. Ensure every employee sees important updates, safety notices, and company wins.

Employee App

Put the power of TimeWellScheduled in your team's pocket. Employees can view schedules, swap shifts, and clock in directly from their mobile devices.

Operations & HR

HR Suite

Centralize employee training, asset tracking, and digital files. Maintain compliance with comprehensive, easy-to-access records.

Project Tracking

Monitor labor costs against specific projects or tasks. Gain visibility into equipment usage and real-time productivity.

Retail

Hotel

Restaurant

Grocery Store

Long Term Care

Compare Alternatives

TimeWellScheduled - Employee Scheduling Software Logo
Contact Us
Employee Login

API SERVICE Developer Documentation

XML & JSON API Reference

TABLE OF CONTENTS

1. Introduction

The TimeWellScheduled API allows developers to securely integrate scheduling, time tracking, payroll, and HR features into their applications. All requests are made over HTTPS and return structured data in either JSON or XML formats.

2. Getting Started

Before you begin, you'll need an API Key and Company ID.
Follow the API key setup guide to generate your API key.

API URL:

3. Authentication & Security

  • Application ID [appid] - provided by us API key setup guide
  • Company ID [c] - your unique company. It can be found here
  • Module [module] - the module being called
  • Encryption: All passwords are stored using bCrypt

You'll need to hash employee credentials with the company-specific salt provided during authentication. For more on bCrypt, read this.

4. Request Overview

The API Service provides programmatic access to employee, scheduling, attendance, payroll, and company information.

The API supports two endpoint types. The endpoint determines the HTTP method and response format.

Endpoint HTTP Method Response Primary Use
response.asp GET XML Attendance and employee actions
response_json.asp POST JSON Lists, schedules, absences, payroll and reporting

Each request must include an Application ID, Company ID, and the appropriate API module. Some modules require additional employee or date/time parameters.

5. Request Authentication & Required Parameters

Every API request requires the following parameters:

Parameter Description Required
appid Your Application ID assigned for API access. Yes
c The Company ID associated with the request. Yes
module The API module/function being requested. Yes

Example

appid={AppID}
c={CompanyID}
module={ModuleName}

6. Request Endpoints

The API exposes two endpoints. Use the endpoint that matches the required response format.

6.1. XML Endpoint — response.asp

GETXML

URL: <API URL>/response.asp

Requests use HTTP GET. Parameters are supplied in the request URL's query string.

GET <API URL>/response.asp?appid={AppID}&c={CompanyID}&module=verify

6.2. JSON Endpoint — response_json.asp

POSTJSON

URL: <API URL>/response_json.asp

Requests use HTTP POST. Parameters are supplied in the request body.

POST <API URL>/response_json.asp
Content-Type: application/x-www-form-urlencoded

{
  "appid": "123456",
  "c": "78910",
  "module": "employee_list"
}

7. Response Format

Requests to response.asp return XML.
Requests to response_json.asp return JSON.

Common Response Fields

Parameter Description Required
success Indicates whether the requested operation was successful. A value of 1 indicates success; 0 indicates failure. Yes
ontime Used by attendance action responses to indicate the timing status of the action. No
message Human-readable information about the result of the request. No
<?xml version="1.0"?>
<response>
<success>1</success>
<ontime>1</ontime>
<message>Your action has been recorded successfully.</message>
</response>
{
  "success": 1
}

8. XML API Modules

The following modules use response.asp and return XML.

8.1. verify

Retrieves company information and the employee list associated with the company.

GETXML

Endpoint: <API URL>/response.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module verify Yes

Example Request

GET /response.asp?appid={AppID}&c={CompanyID}&module=verify

Example Response

<?xml version='1.0' encoding='ISO-8859-1'?>
<response>
    <success>1</success>
    <ontime>1</ontime>
    <AllowLogsAPI>False</AllowLogsAPI>
    <urlLogsAPI>https://api.timewellscheduled.com</urlLogsAPI>
    <levelLogsApi>Trace</levelLogsApi>
    <AllowFaceRecognition>True</AllowFaceRecognition>
    <ValidateFaceRecognition>True</ValidateFaceRecognition>
    <geoLocation>False</geoLocation>
    <recordHours>False</recordHours>
    <iOSVer>307</iOSVer>
    <androidVer>307</androidVer>
    <remoteApi>False</remoteApi>
    <notShowButtonsMeal>False</notShowButtonsMeal>
    <notShowButtonsBreak>False</notShowButtonsBreak>
    <numberOfEmployees>40</numberOfEmployees>
    <message>
        <employees>
            <employee>
                <name>Alfred Murphy</name>
                <id>ALFRED</id>
                <departmenName>Sports</departmenName>
                <totalFace>2</totalFace>
            </employee>
            <employee>
                <name>Barbara-Jean Jones</name>
                <id>123456</id>
                <departmenName>Cash</departmenName>
                <totalFace>2</totalFace>
            </employee>
            <employee>
                <name>Bill Benton</name>
                <id>995</id>
                <departmenName>Customer Service</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Brad R</name>
                <id>4040</id>
                <departmenName>Sports</departmenName>
                <totalFace>2</totalFace>
            </employee>
            <employee>
                <name>Carla C</name>
                <id>3535</id>
                <departmenName>Hardware</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Carly Cat</name>
                <id>carly</id>
                <departmenName>IT</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Carrie Oakey</name>
                <id>998</id>
                <departmenName>Manufacturing</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Chester Field</name>
                <id>111</id>
                <departmenName>Cash</departmenName>
                <totalFace>3</totalFace>
            </employee>
            <employee>
                <name>Chris P. Bacon</name>
                <id>555</id>
                <departmenName>Customer Service</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Christian P</name>
                <id>444</id>
                <departmenName>Sports</departmenName>
                <totalFace>1</totalFace>
            </employee>
            <employee>
                <name>Christian E</name>
                <id>christian</id>
                <departmenName>Management</departmenName>
                <totalFace>8</totalFace>
            </employee>
            <employee>
                <name>Clair Voyant</name>
                <id>144</id>
                <departmenName>Office</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Crystal Clear</name>
                <id>123</id>
                <departmenName>Hardware</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>David M</name>
                <id>44444</id>
                <departmenName>Hardware</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>dcteam dcteam</name>
                <id>dcteam</id>
                <departmenName>Automotive</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Diego T</name>
                <id>987</id>
                <departmenName>Sports</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Harry Manner</name>
                <id>admin3</id>
                <departmenName>Sports</departmenName>
                <totalFace>1</totalFace>
            </employee>
            <employee>
                <name>Hummels Dortmund</name>
                <id>0001</id>
                <departmenName>Automotive</departmenName>
                <totalFace>1</totalFace>
            </employee>
            <employee>
                <name>Jack L</name>
                <id>jlabine</id>
                <departmenName>Sports</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>James P</name>
                <id>8765</id>
                <departmenName>Sports</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Jasmin W</name>
                <id>997</id>
                <departmenName>Manufacturing</departmenName>
                <totalFace>1</totalFace>
            </employee>
            <employee>
                <name>Jhon Connor</name>
                <id>7717</id>
                <departmenName>IT</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Jim Bob</name>
                <id>999</id>
                <departmenName>Bakery</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Jim Evoy</name>
                <id>543</id>
                <departmenName>Management</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>John Smith</name>
                <id>333</id>
                <departmenName>Cash</departmenName>
                <totalFace>2</totalFace>
            </employee>
            <employee>
                <name>Justin Time</name>
                <id>tws</id>
                <departmenName>Customer Service</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Linda C</name>
                <id>30088</id>
                <departmenName>Office</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Lore Sanchez</name>
                <id>lore</id>
                <departmenName>Cash</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Marcelo Sanchez</name>
                <id>marcelo</id>
                <departmenName>Automotive</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Mark K</name>
                <id>admin</id>
                <departmenName>Management</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Melvin Smothers</name>
                <id>222</id>
                <departmenName>Cash</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Melvin Smith</name>
                <id>123a</id>
                <departmenName>Customer Service</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Natalia C</name>
                <id>Nair</id>
                <departmenName>Customer Service</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Paige Turner</name>
                <id>1515</id>
                <departmenName>Cash</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Pearl White</name>
                <id>pearl1</id>
                <departmenName>Cash</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Polly Esther</name>
                <id>12345</id>
                <departmenName>Management</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Regina Rodriguez</name>
                <id>2204</id>
                <departmenName>Sports</departmenName>
                <totalFace>1</totalFace>
            </employee>
            <employee>
                <name>Roger P</name>
                <id>321</id>
                <departmenName>Sports</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Scott M</name>
                <id>541</id>
                <departmenName>Sports</departmenName>
                <totalFace>0</totalFace>
            </employee>
            <employee>
                <name>Stan Still</name>
                <id>4444</id>
                <departmenName>Hardware</departmenName>
                <totalFace>0</totalFace>
            </employee>
        </employees>
        <branding logo=''>Your Company Here</branding>
        <bcryptSalt>yourKey</bcryptSalt>
        <logo>
            <![CDATA[https://url_to_logo/MainLogo.png]]>
        </logo>
        <companyName>Your Company Name</companyName>
        <companyUniqueCode>CompanyUniqueCode</companyUniqueCode>
    </message>
</response>

8.2. begin

Records the beginning of an employee's work shift.

GETXML

Endpoint: <API URL>/response.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module begin Yes

Additional Parameters

Parameter Description Required
eCode Punch code Yes
p Employee password in bcrypt format Yes
Year Year Yes
Month Month Yes
Day Day Yes
Hour Hour Yes
Minute Minute Yes
Second Second Yes
Reason ReasonID - If a watchdog event is returned, resubmit the same request with the selected reason ID using the reason parameter. No
Detail If a watchdog event is returned and parameter Explanation="1", resubmit the same request with the selected reason ID using the reason parameter, and the Detail parameter to provide more details on the selected reason. No

Example Request

GET /response.asp?appid={AppID}&c={CompanyID}&module=begin&eCode={punchCode}&p={bCryptPassword}&Year=2025&Month=9&Day=22&Hour=16&Minute=36&Second=34

Example Response

<?xml version="1.0"?>
<response>
<success>0</success>
<ontime>0</ontime>
<codeAlert>3</codeAlert>
<codeAlertDetail>Late</codeAlertDetail>
<title>Response required!</title>
<message>You are 36 minute(s) late</message>
<watchdog>
<message>Select a reason.</message>
<reasons>
  <reason ID="153" Explanation="0">Car problems</reason>
  <reason ID="157" Explanation="0">Computer issues</reason>
  <reason ID="1983" Explanation="1">Early out</reason>
  <reason ID="159" Explanation="0">Finished early</reason>
  <reason ID="154" Explanation="0">Not feeling well</reason>
  <reason ID="156" Explanation="1">Other (Please explain)</reason>
  <reason ID="1482" Explanation="0">Personal issues</reason>
  <reason ID="158" Explanation="0">Traffic</reason>
  <reason ID="155" Explanation="0">Weather</reason>
</reasons>
</watchdog>
</response>
Note: If a watchdog event is returned, resubmit the same request with the selected reason ID using the reason parameter. If parameter Explanation="1" then you need to send also parameter Detail.

8.2.1. Retrying after a watchdog response

When the end request returns a watchdog event, submit the request again with the selected reason ID and Detail if necessary.

GET <API
URL>/response.asp?appid={AppID}&c={CompanyID}&module=begin&eCode={punchCode}&p={bCryptPassword}&Year=2025&Month=9&Day=22&Hour=16&Minute=36&Second=34&reason={reasonID}&detail={txt}

<?xml version="1.0"?>
<response>
<success>1</success>
<ontime>1</ontime>
<message>Your action has been recorded successfully. You have 12 unread message(s) in your Inbox.</message>
</response>

8.3. end

Records the end of an employee's work shift.

GETXML

Endpoint: <API URL>/response.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module end Yes

Additional Parameters

Parameter Description Required
eCode Punch code Yes
p Employee password in bcrypt format Yes
Year Year Yes
Month Month Yes
Day Day Yes
Hour Hour Yes
Minute Minute Yes
Second Second Yes
Reason ReasonID If a watchdog event is returned, resubmit the same request with the selected reason ID using the reason parameter. No
Detail If a watchdog event is returned and parameter Explanation="1", resubmit the same request with the selected reason ID using the reason parameter, and the Detail -text type- parameter to provide more details on the selected reason. No

Example Request

GET <API
URL>/response.asp?appid={AppID}&c={CompanyID}&module=end&eCode={punchCode}&p={bCryptPassword}&Year=2025&Month=9&Day=22&Hour=19&Minute=04&Second=25

Example Response

<?xml version="1.0"?>
<response>
  <success>1</success>
  <ontime>1</ontime>
  <message>Your action has been recorded successfully.</message>
</response>

8.4. break

Records the start or end of an employee break.

GETXML

Endpoint: <API URL>/response.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module break Yes

Additional Parameters

Parameter Description Required
eCode Punch code Yes
p Employee password in bcrypt format Yes
Year Year Yes
Month Month Yes
Day Day Yes
Hour Hour Yes
Minute Minute Yes
Second Second Yes
Reason ReasonID - If a watchdog event is returned, resubmit the same request with the selected reason ID using the reason parameter. No
Detail If a watchdog event is returned and parameter Explanation="1", resubmit the same request with the selected reason ID using the reason parameter, and the Detail parameter to provide more details on the selected reason. No

Example Request

GET <API
URL>/response.asp?appid={AppID}&c={CompanyID}&module=break&eCode={punchCode}&p={bCryptPassword}&Year=2025&Month=9&Day=22&Hour=18&Minute=15&Second=09

Example Response

<?xml version="1.0"?>
<response>
  <success>1</success>
  <ontime>1</ontime>
  <message>Your action has been recorded successfully.</message>
</response>

8.5. meal

Records the start or end of an employee meal period.

GETXML

Endpoint: <API URL>/response.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module meal Yes

Additional Parameters

Parameter Description Required
eCode Punch code Yes
p Employee password in bcrypt format Yes
Year Year Yes
Month Month Yes
Day Day Yes
Hour Hour Yes
Minute Minute Yes
Second Second Yes
Reason ReasonID - If a watchdog event is returned, resubmit the same request with the selected reason ID using the reason parameter. No
Detail If a watchdog event is returned and parameter Explanation="1", resubmit the same request with the selected reason ID using the reason parameter, and the Detail parameter to provide more details on the selected reason. No

Example Request

GET <API
URL>/response.asp?appid={AppID}&c={CompanyID}&module=meal&eCode={punchCode}&p={bCryptPassword}&Year=2025&Month=9&Day=22&Hour=17&Minute=08&Second=25

Example Response

<?xml version="1.0"?>
<response>
  <success>0</success>
  <ontime>0</ontime>
  <message>This action cannot be done. Your schedule does not allow any MEALS</message>
</response>

9. JSON API Modules

The following modules use response_json.asp and return JSON.

9.1. schedule_list

Retrieves employee schedules for a specified date range.

POSTJSON

Endpoint: <API URL>/response_json.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module schedule_list Yes

Additional Parameters

Parameter Description Required
eCode Punch code. Use 0 to retrieve schedules for all employees. Yes
StartDate Beginning of the date range. Yes
EndDate End of the date range. Yes

Example Request

POST <API URL>/response_json.asp
Content-Type: application/x-www-form-urlencoded

{
    "appid": "123456",
    "c": "78910",
    "module": "schedule_list",
    "eCode": "0",
    "StartDate": "2025-09-01",
    "EndDate": "2025-09-14"
}

Example Response

{
    "schedules": [
        {
            "scheduleID": 62009518,
            "employeeName": "Chester Field",
            "employeeCode": "111",
            "payrollCode": "111",
            "date": "2025-9-11",
            "dateString": "Thu Sep 11, 2025",
            "time": "9:00 AM-5:00 PM",
            "TotalHoursScheduled": "7.5",
            "TotalHoursPaid": "6.5",
            "TotalActualHours": "2",
            "type": "Regular Hours",
            "deptName": "Customer Service",
            "deptColor": "#e52e2e",
            "roleBelong": "Day shift",
            "comment": "",
            "wordDepartment": "Department",
            "wordRole": "Role",
            "dayStartDate": 11,
            "dayNameStartDate": "Thu",
            "wordIn": "In",
            "wordAs": "As",
            "breaksMealsString": [
            ]
        },
        {
            "scheduleID": 62009712,
            "employeeName": "Chris P. Bacon",
            "employeeCode": "555",
            "payrollCode": "555",
            "date": "2025-9-10",
            "dateString": "Wed Sep 10, 2025",
            "time": "9:00 AM-5:00 PM",
            "TotalHoursScheduled": "7.5",
            "TotalHoursPaid": "7.5",
            "TotalActualHours": 0,
            "type": "Regular Hours",
            "deptName": "Hardware",
            "deptColor": "#e5e0a2",
            "roleBelong": "Day shift",
            "comment": "",
            "wordDepartment": "Department",
            "wordRole": "Role",
            "dayStartDate": 10,
            "dayNameStartDate": "Wed",
            "wordIn": "In",
            "wordAs": "As",
            "breaksMealsString": [
            ]
        },
        {
            "scheduleID": 65713974,
            "employeeName": "Crystal Clear",
            "employeeCode": "123",
            "payrollCode": "123",
            "date": "2025-9-2",
            "dateString": "Tue Sep 2, 2025",
            "time": "9:00 AM-1:00 PM",
            "TotalHoursScheduled": "4",
            "TotalHoursPaid": "4",
            "TotalActualHours": 0,
            "type": "Regular Hours",
            "deptName": "Bakery",
            "deptColor": "#e577dc",
            "roleBelong": "Manager Level 2",
            "comment": "",
            "wordDepartment": "Department",
            "wordRole": "Role",
            "dayStartDate": 2,
            "dayNameStartDate": "Tue",
            "wordIn": "In",
            "wordAs": "As",
            "breaksMealsString": [
            ]
        },
        {
            "scheduleID": 62009689,
            "employeeName": "Jim Bob",
            "employeeCode": "999",
            "payrollCode": "999",
            "date": "2025-9-12",
            "dateString": "Fri Sep 12, 2025",
            "time": "9:00 AM-5:00 PM",
            "TotalHoursScheduled": "7.5",
            "TotalHoursPaid": "7.5",
            "TotalActualHours": 0,
            "type": "Regular Hours",
            "deptName": "Customer Service",
            "deptColor": "#e52e2e",
            "roleBelong": "PPT",
            "comment": "",
            "wordDepartment": "Department",
            "wordRole": "Role",
            "dayStartDate": 12,
            "dayNameStartDate": "Fri",
            "wordIn": "In",
            "wordAs": "As",
            "breaksMealsString": [
                {
                    "wordAction": "Break",
                    "actionHour": "10:00 AM",
                    "actionType": 4
                },
                {
                    "wordAction": "Meal",
                    "actionHour": "12:00 PM",
                    "actionType": 3
                },
                {
                    "wordAction": "Break",
                    "actionHour": "2:00 PM",
                    "actionType": 4
                }
            ]
        }
    ],
    "header": "Upcoming Shifts",
    "TotalHoursScheduledRange": "26.5",
    "TotalActualHoursRange": "2",
    "TotalPaidHoursRange": "25.5",
    "success": "1",
    "ontime": "1",
    "reply": 30
}

9.2. employee_list

Retrieves the list of all active employees.

POSTJSON

Endpoint: <API URL>/response_json.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module employee_list Yes

Example Request

POST <API URL>/response_json.asp
Content-Type: application/x-www-form-urlencoded

{
    "appid": "123456",
    "c": "78910",
    "module": "employee_list"
}

Example Response

{
    "employees": [
        {
            "name": "Alfred",
            "lastName": "Murphy",
            "employeeCode": "ALFRED",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "540 Highway 311",
            "postalCode": "N6G5E1",
            "birthday": "2023-06-06",
            "hireDate": "2022-03-17",
            "terminationDate": null,
            "phone1": "222-111-1111",
            "phone2": "111-111-1111"
        },
        {
            "name": "Barbara-Jean",
            "lastName": "Jones",
            "employeeCode": "123456",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2021-03-10",
            "hireDate": "2021-03-10",
            "terminationDate": null,
            "phone1": "111-111-1111",
            "phone2": "222-111-3333"
        },
        {
            "name": "Bill",
            "lastName": "Benton",
            "employeeCode": "995",
            "payrollType": "Salaried",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2012-12-06",
            "hireDate": "2012-12-06",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Brad",
            "lastName": "R",
            "employeeCode": "4040",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2012-12-05",
            "hireDate": "2012-12-05",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Carla",
            "lastName": "C",
            "employeeCode": "1211",
            "payrollType": "Salaried",
            "internalStatusName": "Leave Of Absence",
            "street": "",
            "postalCode": "",
            "birthday": "2012-03-06",
            "hireDate": "2011-10-12",
            "terminationDate": null,
            "phone1": "012 346 1278",
            "phone2": ""
        },
        {
            "name": "Carla",
            "lastName": "C",
            "employeeCode": "3535",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "70790012",
            "birthday": "2013-02-08",
            "hireDate": "2013-09-23",
            "terminationDate": null,
            "phone1": "70790016",
            "phone2": ""
        },
        {
            "name": "Carly",
            "lastName": "Cat",
            "employeeCode": "carly",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2020-05-20",
            "hireDate": "2020-05-20",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Carrie",
            "lastName": "Oakey",
            "employeeCode": "998",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2012-12-06",
            "hireDate": "2012-12-06",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Chester",
            "lastName": "Field",
            "employeeCode": "111",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2020-11-24",
            "hireDate": "2011-01-03",
            "terminationDate": null,
            "phone1": "444-555-4567",
            "phone2": ""
        },
        {
            "name": "Chris",
            "lastName": "P. Bacon",
            "employeeCode": "555",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "413 rue Price",
            "postalCode": "",
            "birthday": "2017-09-19",
            "hireDate": "2021-10-01",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Christian",
            "lastName": "P",
            "employeeCode": "444",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "4-25piette",
            "postalCode": "J7G1L8",
            "birthday": "1959-03-01",
            "hireDate": "2004-05-21",
            "terminationDate": null,
            "phone1": "514-402-6373",
            "phone2": ""
        },
        {
            "name": "Christian",
            "lastName": "E",
            "employeeCode": "christian",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2017-08-29",
            "hireDate": "2017-03-29",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Clair",
            "lastName": "Voyant",
            "employeeCode": "144",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "12 rue Kelly",
            "postalCode": "",
            "birthday": "1992-11-30",
            "hireDate": "2012-11-26",
            "terminationDate": null,
            "phone1": "819-777-1234",
            "phone2": ""
        },
        {
            "name": "Crystal",
            "lastName": "Clear",
            "employeeCode": "123",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2018-04-30",
            "hireDate": "2018-04-30",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Danae",
            "lastName": "C",
            "employeeCode": "danae",
            "payrollType": "Salaried",
            "internalStatusName": "Terminated",
            "street": "",
            "postalCode": "",
            "birthday": "2022-09-29",
            "hireDate": "2017-09-19",
            "terminationDate": "2023-06-06 4:00:00 AM",
            "phone1": "111-111-1111",
            "phone2": ""
        },
        {
            "name": "David",
            "lastName": "M",
            "employeeCode": "44444",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2012-08-14",
            "hireDate": "2012-03-05",
            "terminationDate": null,
            "phone1": null,
            "phone2": ""
        },
        {
            "name": "dcteam",
            "lastName": "dcteam",
            "employeeCode": "dcteam",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2026-06-26",
            "hireDate": "2026-06-26",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Diego",
            "lastName": "T",
            "employeeCode": "987",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2017-06-08",
            "hireDate": "2017-06-08",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Harry",
            "lastName": "Manner",
            "employeeCode": "admin3",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2018-05-02",
            "hireDate": "2018-05-02",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Heydi",
            "lastName": "E",
            "employeeCode": "343",
            "payrollType": "Hourly",
            "internalStatusName": "Leave Of Absence",
            "street": "",
            "postalCode": "",
            "birthday": "2012-03-08",
            "hireDate": "2011-10-12",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Hummels",
            "lastName": "Dortmund",
            "employeeCode": "0001",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "Av. La Vie in Rose",
            "postalCode": "",
            "birthday": "2024-05-10",
            "hireDate": "2024-05-10",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Jack",
            "lastName": "L",
            "employeeCode": "jlabine",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "12 rue Kelly",
            "postalCode": "",
            "birthday": "2012-11-26",
            "hireDate": "2012-11-26",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "James",
            "lastName": "P",
            "employeeCode": "8765",
            "payrollType": "Commissioned",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2014-02-24",
            "hireDate": "2014-02-24",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Jasmin",
            "lastName": "W",
            "employeeCode": "997",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "1959-01-30",
            "hireDate": "2012-12-06",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Jhon",
            "lastName": "Connor",
            "employeeCode": "7717",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2023-10-11",
            "hireDate": "2023-10-11",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Jim",
            "lastName": "Bob",
            "employeeCode": "999",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2012-12-06",
            "hireDate": "2012-12-06",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Jim",
            "lastName": "Evoy",
            "employeeCode": "543",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2021-04-28",
            "hireDate": "2016-02-15",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Jim",
            "lastName": "Moya",
            "employeeCode": "test",
            "payrollType": "Hourly",
            "internalStatusName": "Terminated",
            "street": "",
            "postalCode": "",
            "birthday": "2019-09-24",
            "hireDate": "2019-09-01",
            "terminationDate": "2023-02-14 5:00:00 AM",
            "phone1": "555-555-5555",
            "phone2": ""
        },
        {
            "name": "John",
            "lastName": "Smith",
            "employeeCode": "333",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "1st Street",
            "postalCode": "N6G5E1",
            "birthday": "2012-03-07",
            "hireDate": "2010-12-27",
            "terminationDate": null,
            "phone1": "519-555-5555",
            "phone2": ""
        },
        {
            "name": "Justin",
            "lastName": "Time",
            "employeeCode": "tws",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2024-12-24",
            "hireDate": "2024-12-24",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Larry",
            "lastName": "Deleted",
            "employeeCode": "300889",
            "payrollType": "Hourly",
            "internalStatusName": "Terminated",
            "street": "",
            "postalCode": "",
            "birthday": "2018-03-12",
            "hireDate": "2016-10-21",
            "terminationDate": "2018-08-04 4:00:00 AM",
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Linda",
            "lastName": "C",
            "employeeCode": "30088",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2016-11-03",
            "hireDate": "2016-10-21",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Lore",
            "lastName": "Sanchez",
            "employeeCode": "lore",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2023-10-30",
            "hireDate": "2023-10-30",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Luis",
            "lastName": "M",
            "employeeCode": "lfmc",
            "payrollType": "Hourly",
            "internalStatusName": "Quit",
            "street": "",
            "postalCode": "",
            "birthday": "2021-05-26",
            "hireDate": "2021-05-26",
            "terminationDate": "2025-04-14 3:01:42 PM",
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Luis",
            "lastName": "M",
            "employeeCode": "232",
            "payrollType": "Hourly",
            "internalStatusName": "Maternity Leave",
            "street": "",
            "postalCode": "",
            "birthday": null,
            "hireDate": "2011-10-12",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Marcelo",
            "lastName": "Sanchez",
            "employeeCode": "marcelo",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2024-05-10",
            "hireDate": "2024-05-10",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Mark",
            "lastName": "K",
            "employeeCode": "admin",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "R.R.#12",
            "postalCode": "limit",
            "birthday": "2012-03-05",
            "hireDate": "2011-03-31",
            "terminationDate": null,
            "phone1": "111-222-2222",
            "phone2": "222-666-5555"
        },
        {
            "name": "Melvin",
            "lastName": "Smothers",
            "employeeCode": "222",
            "payrollType": "Salaried",
            "internalStatusName": "Active",
            "street": "1st Street",
            "postalCode": "N6G5E1",
            "birthday": "2012-06-19",
            "hireDate": "2011-01-10",
            "terminationDate": null,
            "phone1": "519-555-5555",
            "phone2": ""
        },
        {
            "name": "Melvin",
            "lastName": "Smith",
            "employeeCode": "123a",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2023-03-29",
            "hireDate": "2023-03-29",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Mery",
            "lastName": "G",
            "employeeCode": "654",
            "payrollType": "Hourly",
            "internalStatusName": "Maternity Leave",
            "street": "none",
            "postalCode": "h0h0h0h0h0",
            "birthday": "2014-04-15",
            "hireDate": "2012-02-17",
            "terminationDate": "2020-03-25 4:00:00 AM",
            "phone1": "111-222-3333",
            "phone2": ""
        },
        {
            "name": "new",
            "lastName": "new",
            "employeeCode": "new",
            "payrollType": "Hourly",
            "internalStatusName": "Long Term Disability",
            "street": "",
            "postalCode": "",
            "birthday": "2021-09-16",
            "hireDate": "2021-09-16",
            "terminationDate": "2022-01-10 3:51:52 PM",
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "new1",
            "lastName": "new1",
            "employeeCode": "new1",
            "payrollType": "Hourly",
            "internalStatusName": "Maternity Leave",
            "street": "",
            "postalCode": "",
            "birthday": "2021-10-29",
            "hireDate": "2021-10-29",
            "terminationDate": "2022-01-10 5:00:00 AM",
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "new2",
            "lastName": "new2",
            "employeeCode": "new2",
            "payrollType": "Hourly",
            "internalStatusName": "Short Term Disability",
            "street": "",
            "postalCode": "",
            "birthday": "2021-10-29",
            "hireDate": "2021-11-01",
            "terminationDate": "2022-01-10 5:00:00 AM",
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Paige",
            "lastName": "Turner",
            "employeeCode": "1515",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2024-10-30",
            "hireDate": "2024-10-30",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Pearl",
            "lastName": "White",
            "employeeCode": "pearl1",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2022-03-07",
            "hireDate": "2022-03-07",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Polly",
            "lastName": "Esther",
            "employeeCode": "12345",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2020-11-19",
            "hireDate": "2020-11-19",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Regina",
            "lastName": "Rodriguez",
            "employeeCode": "2204",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2020-06-26",
            "hireDate": "2020-06-26",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Roger",
            "lastName": "P",
            "employeeCode": "321",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2015-08-24",
            "hireDate": "2015-08-24",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Scott",
            "lastName": "M",
            "employeeCode": "541",
            "payrollType": "Salaried",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "2021-08-02",
            "hireDate": "2016-02-15",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "Stan",
            "lastName": "Still",
            "employeeCode": "4444",
            "payrollType": "Hourly",
            "internalStatusName": "Active",
            "street": "",
            "postalCode": "",
            "birthday": "1959-03-01",
            "hireDate": "2015-02-21",
            "terminationDate": null,
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "test",
            "lastName": "test",
            "employeeCode": "test1",
            "payrollType": "Hourly",
            "internalStatusName": "Quit",
            "street": "",
            "postalCode": "",
            "birthday": "2021-10-18",
            "hireDate": "2021-10-18",
            "terminationDate": "2022-01-10 5:00:00 AM",
            "phone1": "",
            "phone2": ""
        },
        {
            "name": "User",
            "lastName": "Tester",
            "employeeCode": "teamst1",
            "payrollType": "Salaried",
            "internalStatusName": "Maternity Leave",
            "street": "",
            "postalCode": "",
            "birthday": "2022-06-15",
            "hireDate": "2022-06-15",
            "terminationDate": "2023-01-06 5:00:00 AM",
            "phone1": "",
            "phone2": ""
        }
    ],
    "success": "1",
    "ontime": "1",
    "reply": 33
}

9.3. absence_list

Retrieves employee absences within a specified date range.

POSTJSON

Endpoint: <API URL>/response_json.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module absence_list Yes

Additional Parameters

Parameter Description Required
eCode Punch code. Use 0 to retrieve absences for all employees. Yes
StartDate Beginning of the date range. Yes
EndDate End of the date range. Yes

Example Request

POST <API URL>/response_json.asp
Content-Type: application/x-www-form-urlencoded

{
    "appid": "123456",
    "c": "78910",
    "module": "absence_list",
    "eCode": "995",
    "StartDate": "2025-08-01",
    "EndDate": "2025-08-31"
}

Example Response

{
    "absences": [
        {
            "absenceID": 3975935,
            "employeeName": "Bill Benton",
            "employeeCode": "995",
            "requestDateTime": "2025-09-11 2:46:44 PM",
            "requestFrom": "2025-08-08 9:00:00 AM",
            "requestTo": "2025-08-08 4:30:00 PM",
            "dateString": "Aug 8-Aug 8,2025",
            "allDay": false,
            "time": "9:00 AM - 4:30 PM",
            "requestType": "Did not show up",
            "hours": "7",
            "comment": "Schedule From: August 8, 2025 9:00 AM To: August 8, 2025
5:00 PM",
            "status": "Approved",
            "colorAbsence": "#81c784",
            "colorText": "#2e7d32",
            "wordType": "Type",
            "wordComment": "Comments",
            "wordHours": "Hours",
            "dayFrom": 8,
            "dayTo": 8,
            "dayNameFrom": "Fri",
            "dayNameTo": "Fri",
            "date": "2025-08-08",
            "detailAbsence": "Hours: 7",
            "quantityDays": 1,
            "wordTime": "Time",
            "buttonDelete": "",
            "buttonEdit": "",
            "wordRequest": "Request"
        }
    ],
    "header": "Absences",
    "success": "1",
    "ontime": "1",
    "reply": 39
}

9.4. payroll_list

Retrieves payroll information for a specified date range.

POSTJSON

Endpoint: <API URL>/response_json.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module payroll_list Yes

Additional Parameters

Parameter Description Required
StartDate Beginning of the date range. This must be the date your business starts its work week. I.e.: a date on a Monday Yes
EndDate End of the date range. This must be the date your business ends its work week. I.e.: a date on the next Sunday Yes

Example Request

POST <API URL>/response_json.asp
Content-Type: application/x-www-form-urlencoded

{
    "appid": "123456",
    "c": "78910",
    "module": "payroll_list",
    "StartDate": "2025-09-06",
    "EndDate": "2025-09-13"
}

Example Response

{
    "payroll": [
        {
            "period": "September 7, 2025-September 13, 2025",
            "employeeData": [
                {
                    "employeeName": "Murphy Alfred",
                    "employeeCode": "ALFRED",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Jones Barbara-Jean",
                    "employeeCode": "123456",
                    "primaryDepartment": "Cash",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Benton Bill",
                    "employeeCode": "995",
                    "primaryDepartment": "Customer Service",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "R Brad",
                    "employeeCode": "4040",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "C Carla",
                    "employeeCode": "3535",
                    "primaryDepartment": "Hardware",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Cat Carly",
                    "employeeCode": "carly",
                    "primaryDepartment": "IT",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Oakey Carrie",
                    "employeeCode": "998",
                    "primaryDepartment": "Manufacturing",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Field Chester",
                    "employeeCode": "111",
                    "primaryDepartment": "Cash",
                    "totalRT": 6.5,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 2,
                    "totalDays": 2
                },
                {
                    "employeeName": "P. Bacon Chris",
                    "employeeCode": "555",
                    "primaryDepartment": "Customer Service",
                    "totalRT": 7.5,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 1,
                    "totalDays": 1
                },
                {
                    "employeeName": "E Christian",
                    "employeeCode": "christian",
                    "primaryDepartment": "Management",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "P Christian",
                    "employeeCode": "444",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Voyant Clair",
                    "employeeCode": "144",
                    "primaryDepartment": "Office",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Clear Crystal",
                    "employeeCode": "123",
                    "primaryDepartment": "Hardware",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "M David",
                    "employeeCode": "44444",
                    "primaryDepartment": "Hardware",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "dcteam dcteam",
                    "employeeCode": "dcteam",
                    "primaryDepartment": "Automotive",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "T Diego",
                    "employeeCode": "987",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Manner Harry",
                    "employeeCode": "admin3",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Dortmund Hummels",
                    "employeeCode": "0001",
                    "primaryDepartment": "Automotive",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "L Jack",
                    "employeeCode": "jlabine",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "P James",
                    "employeeCode": "8765",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "W Jasmin",
                    "employeeCode": "997",
                    "primaryDepartment": "Manufacturing",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Connor Jhon",
                    "employeeCode": "7717",
                    "primaryDepartment": "IT",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Bob Jim",
                    "employeeCode": "999",
                    "primaryDepartment": "Bakery",
                    "totalRT": 7.5,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 1,
                    "totalDays": 1
                },
                {
                    "employeeName": "Evoy Jim",
                    "employeeCode": "543",
                    "primaryDepartment": "Management",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Smith John",
                    "employeeCode": "333",
                    "primaryDepartment": "Cash",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Time Justin",
                    "employeeCode": "tws",
                    "primaryDepartment": "Customer Service",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "C Linda",
                    "employeeCode": "30088",
                    "primaryDepartment": "Office",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Sanchez Lore",
                    "employeeCode": "lore",
                    "primaryDepartment": "Cash",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Sanchez Marcelo",
                    "employeeCode": "marcelo",
                    "primaryDepartment": "Automotive",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "K Mark",
                    "employeeCode": "admin",
                    "primaryDepartment": "Management",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Smith Melvin",
                    "employeeCode": "123a",
                    "primaryDepartment": "Customer Service",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Smothers Melvin",
                    "employeeCode": "222",
                    "primaryDepartment": "Cash",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "C Natalia",
                    "employeeCode": "Nair",
                    "primaryDepartment": "Customer Service",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Turner Paige",
                    "employeeCode": "1515",
                    "primaryDepartment": "Cash",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "White Pearl",
                    "employeeCode": "pearl1",
                    "primaryDepartment": "Cash",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Esther Polly",
                    "employeeCode": "12345",
                    "primaryDepartment": "Management",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Rodriguez Regina",
                    "employeeCode": "2204",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "P Roger",
                    "employeeCode": "321",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "M Scott",
                    "employeeCode": "541",
                    "primaryDepartment": "Sports",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                },
                {
                    "employeeName": "Still Stan",
                    "employeeCode": "4444",
                    "primaryDepartment": "Hardware",
                    "totalRT": 0,
                    "totalOT": 0,
                    "totalDOT": 0,
                    "totalStatOT": 0,
                    "totalShifts": 0,
                    "totalDays": 0
                }
            ]
        }
    ]
}

9.5. who_is_working

Retrieves the list of employees scheduled to work on a specified date. If no date is supplied, the source documentation states that the current day's list is returned.

POSTJSON

Endpoint: <API URL>/response_json.asp

Required Parameters

Parameter Description Required
appid Your Application ID Yes
c Company ID Yes
module who_is_working Yes

Additional Parameters

Parameter Description Required
Date Date for which the schedule should be retrieved. If omitted, the current day's schedule is returned. No

Example Request

POST <API URL>/response_json.asp
Content-Type: application/x-www-form-urlencoded

{
    "appid": "123456",
    "c": "78910",
    "module": "who_is_working",
    "Date": "2025-09-01"
}

Example Response

{
    "schedules": [
        {
            "employeeName": "Chester Fie",
            "departmentName": "Customer Service",
            "departmentCode": "",
            "shiftStartDate": "September 1, 2025",
            "shiftStartTime": "7:00a",
            "shiftEndDate": "September 1, 2025",
            "shiftEndTime": "3:00p",
            "status": "Shift has ended"
        }
    ],
    "isMyNow": false,
    "displayDate": "September 1, 2025",
    "success": "1",
    "ontime": "1",
    "reply": 30
}

10. Date and Time Parameters

The attendance action modules begin, end, break, and meal accept date and time values as individual parameters.

Parameter Description Required
Year Four-digit year, for example 2025. Yes
Month Numeric month, for example 09. Yes
Day Numeric day, for example 22. Yes
Hour Hour in 24-hour format, for example 16. Yes
Minute Minute, for example 05. Yes
Second Second, for example 25. Yes

Date-range modules use the following format:

YYYY-MM-DD
Example: 2025-09-01

11. Error and Status Handling

Applications consuming the API should inspect the API response before assuming that an operation completed successfully.

For XML responses, check the success element. For JSON responses, check the success property.

<success>1</success>
"success": 1

Success values

Parameter Description Required
1 Request completed successfully. Yes
0 Request was unsuccessful. Yes

The message field should also be inspected because it may explain why an operation failed. Some attendance failures may return additional information, such as a watchdog event and reason codes.

12. Quick Reference

Use this table as a fast lookup when integrating a module.

Module Endpoint Method Format Description
verify response.asp GET XML Company and employee information
begin response.asp GET XML Start an employee shift
end response.asp GET XML End an employee shift
break response.asp GET XML Start or end a break
meal response.asp GET XML Start or end a meal period
schedule_list response_json.asp POST JSON Employee schedules
employee_list response_json.asp POST JSON Active employees
absence_list response_json.asp POST JSON Employee absences
payroll_list response_json.asp POST JSON Payroll information
who_is_working response_json.asp POST JSON Employees scheduled to work

XML API

GETXML

<API URL>/response.asp

JSON API

POSTJSON

<API URL>/response_json.asp

13. Support

If you encounter issues: Email: support@wordpress-1368217-6485904.cloudwaysapps.com
Phone: 1-877-689-7977