Press "Enter" to skip to content
< Back

API Calls – Pro Plan

/API/EmployeeList

Parameters: none

FIELD DESCRIPTION
COMPANY_ID Unique ID for a company
W2W_EMPLOYEE_ID ID for an employee (Unique over employees in W2W system)
EMPLOYEE_NUMBER ID for employee (Unique over employees in the company)
FIRST_NAME First name of employee
LAST_NAME Last name of Employee
PHONE Primary Phone number of employee
PHONE_2 Secondary Phone number of employee
MOBILE_PHONE Mobile phone number of employee
EMAILS Email of employee
LAST_SIGN_IN Datetime of last sign to W2W in for employee
SIGN_IN_COUNT Number of times employee has signed in to W2W
ADDRESS Street address of employee
ADDRESS_2 Unit/Apt number of employee
CITY City of employee’s address
STATE State of employee’s address
ZIP Zip Code of Employee’s address
COMMENTS Comments managers have given to employee
MAX_HRS_DAY Maximum allowed hours assigned per day for employee
MAX_SHIFTS_DAY Maximum allowed Shifts assigned per day for employee
MAX_HRS_WEEK Maximum allowed hours assigned per week for employee
MAX_DAYS_WEEK Maximum allowed days assigned per week for employee
HIRE_DATE Date employee was hired
STATUS  
PRIORITY_GROUP  
CUSTOM_1  
CUSTOM_2  
BIWEEKLY_TARGET_HRS Target hours to be assigned to employee every 2 weeks
PAY_RATE Hourly Pay rate for employee
ALERT_DATE  
NEXT_ALERT  

/API/PositionList

Parameters: none

COMPANY_ID Unique ID for a company
POSITION_ID ID for a position (Unique to the company)
POSITION_NAME Name of Position
POSITION_CUSTOM1  
POSITION_CUSTOM2  
POSITION_CUSTOM3  
LAST_CHANGED_TS Timestamp of last change to employee

/API/CategoryList

Parameters: none

COMPANY_ID Unique ID for a company
CATEGORY_ID ID for a Category (Unique to the company)
CATEGORY_NAME Name of Category
CATEGORY_SHORT Abbreviated name of Category
CATEGORY_CUSTOM1  
CATEGORY_CUSTOM2  
CATEGORY_CUSTOM3  
LAST_CHANGED_TS Timestamp of last change 

/API/AssignedShiftList

Parameters: START_DATE=mm/dd/yyyy END_DATE=mm/dd/yyyy

COMPANY_ID Unique ID for a company
SHIFT_ID ID for a shift (Unique to the company)
PUBLISHED Y if shift is published, N if shift is not published
W2W_EMPLOYEE_ID ID for an employee (Unique over employees in W2W system)
FIRST_NAME First name of employee
LAST_NAME Last name of employee
EMPLOYEE_NUMBER ID for an employee (Unique over employees in a company)
START_DATE Start Date of shift
START_TIME Start Time of shift
END_DATE End Date of shift
END_TIME End Time of shift
DURATION Duration of shift in hours
DESCRIPTION Description of shift
POSITION_ID ID for a position (Unique to the company)
POSITION_NAME Name of Position
CATEGORY_ID ID for a category (Unique to the company)
CATEGORY_NAME Name of Category
CATEGORY_SHORT Abbreviated name of Category
COLOR_ID ID for color of shift
PAY_RATE Hourly Pay Rate of the shift
POSITION_CUSTOM1  
POSITION_CUSTOM2  
POSITION_CUSTOM3  
CATEGORY_CUSTOM1  
CATEGORY_CUSTOM2  
CATEGORY_CUSTOM3  
LAST_CHANGED_TS Timestamp of the last change 
LAST_CHANGED_BY Name of user who last changed 

/API/ApprovedTimeOff

Parameters: START_DATE=mm/dd/yyyy END_DATE=mm/dd/yyyy

COMPANY_ID Unique ID for a company
TIMEOFF_ID Unique ID for a Time Off Reservation
W2W_EMPLOYEE_ID ID for the employee taking time off (Unique over employees in W2W system)
FIRST_NAME First name of employee taking time off
LAST_NAME Last name of employee taking time off
EMPLOYEE_NUMBER ID for the employee taking time off (Unique over employees in the company)
DESCRIPTION Description of time off
PARTIAL_DAY Y if partial day off N if full day off
START_DATE Date of the start of time off
START_TIME Time of the start of time off
END_DATE Date of the end of time off
END_TIME Time of the end of time off
WHEN_REQUESTED_TS Timestamp of when the time off was first requested
LAST_CHANGED_TS Timestamp of when the time off was last changed
LAST_CHANGED_BY Name of User who last changed time off

/API/DailyTotals

Parameters: START_DATE=mm/dd/yyyy END_DATE=mm/dd/yyyy

COMPANY_ID Unique ID for a company
SCHEDULE_DATE Date of Schedule
ASSIGNED_SHIFTS Number of assigned shifts on SCHEDULE_DATE
UNASSIGNED_SHIFTS Number of unassigned shifts on SCHEDULE_DATE
ASSIGNED_HOURS Number of assigned hours on SCHEDULE_DATE
UNASSIGNED_HOURS Number of unassigned hours on SCHEDULE_DATE
PAY_RATE (Hourly) Pay rate of (All/Assigned) shifts on SCHEDULE_DATE
TOTAL_PAY Total Pay of shifts on SCHEDULE_DATE

/API/DailyPositionTotals

Parameters: START_DATE=mm/dd/yyyy END_DATE=mm/dd/yyyy

COMPANY_ID Unique ID for a company
SCHEDULE_DATE Date of Schedule
POSITION_ID ID for a position (Unique to the company)
POSITION_NAME Name of Position
ASSIGNED_SHIFTS Number of assigned shifts for POSITION_NAME on SCHEDULE_DATE
UNASSIGNED_SHIFTS Number of unassigned shifts for POSITION_NAME on SCHEDULE_DATE
ASSIGNED_HOURS Number of assigned hours for POSITION_NAME on SCHEDULE_DATE
UNASSIGNED_HOURS Number of unassigned hours for POSITION_NAME on SCHEDULE_DATE
PAY_RATE Hourly Pay Rate of the position for (All/Assigned?) shifts on SCHEDULE_DATE
TOTAL_PAY Total Pay of shifts for POSITION_NAME on SCHEDULE_DATE