Api doc


SDK's


Api Modules

API Explorer

Explore methods and their results by using our Javascript API Explorer.

API
key
token
output


REQUEST
method
module


PARAMETERS
PARAMETERS
allinteger
PARAMETERS
token (Required)varchar
PARAMETERS
PARAMETERS
PARAMETERS
traininginteger
employeeinteger
PARAMETERS
id (Required)integer
contentenum (1, 0)
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
PARAMETERS
PARAMETERS
userinteger
PARAMETERS
PARAMETERS
emailvarchar
storeinteger
PARAMETERS
modeenum (to, from)
PARAMETERS
PARAMETERS
modeenum (inbox, sentbox)
offsetinteger
limitinteger
idinteger
PARAMETERS
id (Required)integer
PARAMETERS
id (Required)integer
PARAMETERS
GET not supported by this method
PARAMETERS
PARAMETERS
currentenum (1)
PARAMETERS
id (Required)integer
PARAMETERS
start_date (Required)date
end_date (Required)date
type (Required)enum (schedule_summary, shift_confirmed, crib_sheet, shift_exchanges, open_shifts, position_summary, shift_acknowledgement)
locationinteger
schedulevarchar
employeevarchar
skillvarchar
with_statusesinteger
optionsinteger
deductbreaksinteger
remote_siteinteger
include_emp_per_posinteger
acknowledgement_statusvarchar
PARAMETERS
start_date (Required)date
end_date (Required)date
type (Required)enum (employees_unscheduled, positions_unscheduled)
locationinteger
schedulevarchar
employeevarchar
PARAMETERS
start_date (Required)date
end_date (Required)date
locationinteger
remote_siteinteger
positioninteger
PARAMETERS
start_date (Required)date
end_date (Required)date
type (Required)enum (timesheets_summary, timesheets_attendance, timesheets_late_summary)
deductbreaksinteger
locationinteger
schedulevarchar
employeevarchar
skillvarchar
remote_siteinteger
approval_statusinteger
PARAMETERS
start_date (Required)date
end_date (Required)date
type (Required)enum (attendance, vacations, availability, unavailability, hourly-availability, vacation-summary)
locationinteger
schedulevarchar
employeevarchar
skillvarchar
fminteger
remote_siteinteger
leave_typeinteger
PARAMETERS
fields (Required)varchar
start_date (Required)date
end_date (Required)date
type (Required)enum (timesheets, confirmedtimesheets, shifts, confirmedshifts, openshifts)
schedulevarchar
employeevarchar
locationinteger
skillvarchar
deduct_breaksmin length 1
remote_siteinteger
optionsvarchar
PARAMETERS
start_date (Required)date
end_date (Required)date
locationvarchar
schedulevarchar
skillvarchar
remote_siteinteger
exclude_disabled_empenum (-1, 1)
PARAMETERS
start_date (Required)date
end_date (Required)date
locationvarchar
PARAMETERS
start_datedate
end_datedate
PARAMETERS
start_datedate
end_datedate
PARAMETERS
year (Required)integer
PARAMETERS
year (Required)integer
PARAMETERS
year (Required)integer
PARAMETERS
year (Required)integer
PARAMETERS
start_date (Required)date
end_date (Required)date
accountinteger
locationinteger
location_namevarchar
scheduleinteger
schedule_namevarchar
skillinteger
employeeinteger
typeenum (drivernumbers, exceptions, schedulednumbers)
PARAMETERS
start_datevarchar
end_datevarchar
employeevarchar
schedulevarchar
remote_sitevarchar
taskvarchar
locationvarchar
task_statevarchar
PARAMETERS
start_datevarchar
end_datevarchar
employeevarchar
schedulevarchar
taskvarchar
locationvarchar
task_statevarchar
workunitvarchar
remote_sitevarchar
group_resultsenum (0, 1, 2)
PARAMETERS
start_datevarchar
end_datevarchar
employeevarchar
schedulevarchar
taskvarchar
locationvarchar
task_statevarchar
workunitvarchar
remote_sitevarchar
PARAMETERS
type (Required)enum (scheduledhours, confirmedhours, timesheets)
start_datedate
end_datedate
locationinteger
schedulevarchar
employeevarchar
skillvarchar
deduct_breaksenum (0, 1)
group_resultsenum (0, 1, 2)
show_emptyenum (0, 1)
split_overnightenum (0, 1)
remote_siteinteger
optionsinteger
include_unapproved_tsinteger
include_remote_sitesinteger
terminal_locationinteger
show_only_mineenum (0, 1)
show_break_timesinteger
include_notesenum (0, 1)
PARAMETERS
start_datedate
end_datedate
locationsvarchar
positionsvarchar
employeesvarchar
skillsvarchar
deduct_breaksenum (0, 1)
group_resultsenum (0, 1, 2)
show_emptyenum (0, 1)
split_overnightenum (0, 1)
remote_siteinteger
optionsinteger
storesvarchar
sortbyenum (sort_by_date_asc, sort_by_date_desc)
PARAMETERS
type (Required)enum (scheduledhours, confirmedhours, timesheets)
start_datedate
end_datedate
locationinteger
schedulevarchar
employeevarchar
skillvarchar
deduct_breaksenum (0, 1)
group_resultsenum (0, 1, 2)
show_emptyenum (0, 1)
split_overnightenum (0, 1)
remote_siteinteger
optionsinteger
include_remote_sitesinteger
include_unapproved_tsinteger
terminal_locationinteger
show_only_mineenum (0, 1)
show_break_timesinteger
include_notesenum (0, 1)
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
id (Required)integer
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
permsenum (1)
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
overnightinteger
start_limitinteger
end_limitinteger
start_datedate
end_datedate
modeenum (overview, location, schedule, incomplete, employees, employee, open, openapproval, confirm, onnow, late, upcoming, recent)
tc_oninteger
schedulevarchar
locationinteger
employeesvarchar
detailedinteger
budgetenum (0, 1)
vacationenum (0, 1)
fmenum (0, 1)
filter_by_sitevarchar
filter_by_employeevarchar
filter_by_skillvarchar
filledenum (0, 1)
PARAMETERS
id (Required)integer
detailedinteger
do_not_initiate_conflictsinteger
PARAMETERS
id (Required)integer
PARAMETERS
modeenum (manage, requested, swap)
PARAMETERS
id (Required)integer
PARAMETERS
id (Required)integer
swapinteger
PARAMETERS
shift_id (Required)integer
PARAMETERS
start_datedate
end_datedate
modeenum (manage, requested, upcoming, all_requested)
user_idinteger
sortbyenum (employee_start, vacation_start)
deletedinteger
force_user_timezoneenum (0, 1)
locationinteger
positioninteger
PARAMETERS
id (Required)integer
force_user_timezoneenum (0, 1)
PARAMETERS
user (Required)integer
start_date (Required)date
end_date (Required)date
scheduleinteger
pageinteger
PARAMETERS
user (Required)integer
start_date (Required)date
end_date (Required)date
scheduleinteger
PARAMETERS
start_date (Required)date
end_date (Required)date
group_byenum (1, 2)
PARAMETERS
start_datedate
end_datedate
modevarchar
schedulevarchar
PARAMETERS
from_start (Required)date
from_end (Required)date
to_start (Required)date
to_end (Required)date
schedulevarchar
locationvarchar
modevarchar
with_staffenum (0, 1, 2)
filter_by_sitevarchar
filter_by_employeevarchar
filter_by_skillvarchar
filter_by_shift_typevarchar
PARAMETERS
start_datedate
end_datedate
scheduleinteger
shiftsvarchar
restoreenum (0, 1)
restoredateunix timestamp
PARAMETERS
start_datedate
end_datedate
schedulevarchar
detailedenum (0, 1)
timestampunix timestamp
PARAMETERS
from_start (Required)date
from_end (Required)date
to_start (Required)date
to_end (Required)date
schedulevarchar
modevarchar
ruleenum (1, 2, 3)
clearmin length 1
forcemin length 1
shiftsvarchar
PARAMETERS
GET not supported by this method
PARAMETERS
shifts (Required)varchar
fill_countinteger
fill_slotsmin length 1
disallow_openslotsmin length 1
PARAMETERS
shifts (Required)varchar
scheduleinteger
notifyenum (, 0, 1, 2)
messagevarchar
start_datedate
end_datedate
notes_startdate
notes_enddate
locationinteger
positionsvarchar
dont_delete_acknowledgementsenum (0, 1)
PARAMETERS
GET not supported by this method
PARAMETERS
idinteger
PARAMETERS
ical_idinteger
start_datedate
end_datedate
PARAMETERS
id (Required)integer
PARAMETERS
GET not supported by this method
PARAMETERS
start_date (Required)date
end_datedate
validvarchar
PARAMETERS
id (Required)integer
PARAMETERS
start_date (Required)date
end_date (Required)date
only_publishedvarchar
PARAMETERS
id (Required)integer
PARAMETERS
id (Required)integer
PARAMETERS
schedulesvarchar
shiftinteger
typevarchar
positionvarchar
employeevarchar
PARAMETERS
GET not supported by this method
PARAMETERS
start_datedate
end_datedate
scheduleinteger
employeeinteger
statusenum (approved, unapproved)
pageinteger
per_pageinteger
order_byenum (id, end_timestamp)
directionenum (asc, desc)
PARAMETERS
id (Required)integer
PARAMETERS
employeeinteger
photovarchar
locationvarchar
latitudevarchar
longitudevarchar
clock_in_timetime
tipsvarchar
PARAMETERS
employeeinteger
PARAMETERS
PARAMETERS
scheduleinteger
notesvarchar
employeeinteger
photovarchar
locationvarchar
clock_out_timetime
latitudevarchar
longitudevarchar
tipsvarchar
PARAMETERS
employeeinteger
detailsenum (1)
PARAMETERS
id (Required)varchar
action (Required)enum (approve, unapprove, reject, delete)
commentvarchar
PARAMETERS
employeeinteger
frequencyenum (15, 30, 60)
datedate
start_timetime
end_timetime
PARAMETERS
PARAMETERS
GET not supported by this method
PARAMETERS
periodvarchar
statusenum (All, Approved, Unapproved)
PARAMETERS
employee (Required)integer
datein (Required)varchar
dateoutvarchar
onlyinenum (0, 1)
scheduleinteger
notesvarchar
remote_siteinteger
tipsvarchar
PARAMETERS
id (Required)integer
notesvarchar
PARAMETERS
id (Required)integer
PARAMETERS
PARAMETERS
idinteger
PARAMETERS
username (Required)varchar
password (Required)varchar
rememberenum (1)
log_datavarchar
PARAMETERS
PARAMETERS
PARAMETERS
schedulevarchar
locationinteger
fmenum (0, 1)
disabledenum (0, 1)
inactiveenum (0, 1)
with_custom_fieldsenum (0, 1)
scheduler_usersmin length 1
check_permissionmin length 1
with_settingsenum (0, 1)
PARAMETERS
idinteger
eidvarchar
log_datavarchar
statusenum (0, 1, -1, -2, deleted, all)
PARAMETERS
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
employee_id (Required)varchar
position_id (Required)varchar
PARAMETERS
employee_id (Required)varchar
PARAMETERS
GET not supported by this method
PARAMETERS
type (Required)varchar
popupmin length 1
revert_buttonmin length 1
PARAMETERS
idinteger
moduleinteger
employeeinteger
identinteger
start_datedate
end_datedate
shift_idvarchar
shiftvarchar
uservarchar
PARAMETERS
deletedvarchar
PARAMETERS
id (Required)integer
PARAMETERS
GET not supported by this method
PARAMETERS
start_date (Required)date
userinteger
approvedenum (0, 1)
PARAMETERS
userinteger
approvedmin length 1
dayenum (1, 2, 3, 4, 5, 6, 7)
timeframemin length 1
PARAMETERS
userinteger
for_approvalmin length 1
PARAMETERS
PARAMETERS
userinteger
approvedenum (0, 1)
start_datedate
end_datedate
PARAMETERS
type (Required)enum (future, weekly)
userinteger
PARAMETERS
typeenum (1, 2)
PARAMETERS
id (Required)integer
PARAMETERS
userinteger
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
sectioninteger
detailedenum (0, 1)
PARAMETERS
id (Required)integer
storeinteger
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
module_id (Required)integer
PARAMETERS
module_id (Required)integer
type (Required)enum (1, 2)
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
tutorial_id (Required)integer
PARAMETERS
detailedenum (0, 1)
detailed_staffenum (0, 1)
PARAMETERS
id (Required)integer
PARAMETERS
GET not supported by this method
PARAMETERS
start_date (Required)date
end_date (Required)date
type (Required)enum (schedule_summary, shifts_confirmed, crib_sheet, shift_exchanges, shifts_summary, open_shifts, position_summary, daily_peak_hours, budget, confirmed_timesheets, all_timesheets, group_statistics)
accountinteger
locationinteger
scheduleinteger
employeeinteger
skillinteger
optionsinteger
deduct_breaksenum (0, 1)
split_overnightenum (0, 1)
group_resultsenum (0, 1, 2)
PARAMETERS
start_date (Required)date
end_date (Required)date
type (Required)enum (unscheduled_employees, unscheduled_positions)
accountinteger
locationinteger
scheduleinteger
employeeinteger
PARAMETERS
start_date (Required)date
end_date (Required)date
PARAMETERS
start_date (Required)date
end_date (Required)date
locationinteger
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
PARAMETERS
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
suggestion_id (Required)integer
PARAMETERS
original_id (Required)varchar
codevarchar
PARAMETERS
lang_suggestion_id (Required)varchar
PARAMETERS
PARAMETERS
code (Required)varchar
filtersvarchar
orig_idvarchar
exclude_filtersvarchar
PARAMETERS
PARAMETERS
PARAMETERS
id (Required)integer
PARAMETERS
lateforworkvarchar
PARAMETERS
PARAMETERS
terminal_key (Required)varchar
idinteger
usernamevarchar
passwordvarchar
computer_idvarchar
ipvarchar
PARAMETERS
terminal_key (Required)varchar
idinteger
photovarchar
logoutenum (0, 1)
computer_idvarchar
ipvarchar
notesvarchar
tipsvarchar
PARAMETERS
terminal_key (Required)varchar
idinteger
photovarchar
scheduleinteger
logoutenum (0, 1)
computer_idvarchar
ipvarchar
notesvarchar
tipsvarchar
PARAMETERS
PARAMETERS
domainvarchar
emailvarchar
phonevarchar
sms_phonevarchar
PARAMETERS
PARAMETERS
PARAMETERS
PARAMETERS
PARAMETERS
PARAMETERS
url (Required)varchar
appdirectvarchar
PARAMETERS
url (Required)varchar
appdirectvarchar
PARAMETERS
url (Required)varchar
appdirectvarchar
PARAMETERS
url (Required)varchar
appdirectvarchar
PARAMETERS
url (Required)varchar
appdirectvarchar
PARAMETERS
url (Required)varchar
appdirectvarchar
PARAMETERS
domain (Required)varchar
appdirectvarchar
PARAMETERS
section_idinteger
module_idinteger
detailedenum (0, 1)
PARAMETERS
module_id (Required)integer
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
shift_id (Required)integer
PARAMETERS
start_timestamp (Required)varchar
end_timestamp (Required)varchar
PARAMETERS
PARAMETERS
user_id (Required)integer
schedule_id (Required)integer
date (Required)date
PARAMETERS
PARAMETERS
requestsinteger
startvarchar
endvarchar
schedule_idinteger
user_idinteger
wu_type_idinteger
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method
PARAMETERS
GET not supported by this method



GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close