Jump to Content

Guides API Reference

v1.0

API Reference

v1.0

Availability

availabilitypost
availability/custom/{id}post
availability/repeated/{id}post
availability/repeatedget
availability/customget
availability/{id}/repeateddelete
availability/{id}delete

Departments

departmentsget
departments/{id}get
departments/departmentscountget
departmentspost
departments/{id}post

Employees

employeesget
employees/{id}get
employees/{id}/currentemployeeget
employees/countget
employees/bydepartment/{department ID}get
employees/withterminatedget
employees/accessibleget
employees/adminsget
employees/supervisorsget
employees/export/{format}post
employees/withpositionpost
employees/{id}post
employees/{id}/contactinfopost
employees/massdeletepost
employees/invitepost
employees/invite/allpost
employees/terminatepost
employees/unterminatepost
employees/{id}delete
employees/{employeeId}/positionsdropdownget
employees/{employeeId}/contactinformationget
employees/{location id}/employeesbyemploymentsget
employees/{employeeId}/positionspost
employees/{employeeId}/schedulerulespost
employees/positions/{employmentId}post
employees/positions/{employment id}delete
employeespost

Enums

RepeatType
Content Providers
ReportRange

Holiday

holidaysget
holidays/{holiday id}get
holidayspost
holidays/{holiday id}post
holidays/{holiday id}delete

Locations

locationsget
locations/{locationId}get
locations/accessiblelocationsget
locations/primaryget
locations/locationscountget
locationspost
locations/{location id}post
locations/{location id}/hourspost

Positions

positionsget
positions/{position id}get
positions/positionscountget
positionspost
positions/{position id}post

Reports

report/locationsget
report/locations/export/{format}get
report/{location id}/locationsget
report/{location id}/locations/export/{format}get
report/scheduleget
report/schedule/export/{format}get
report/employeesget
report/employees/{report type}/export/{format}get
report/misc/certificatesget
report/misc/certificates/export/{format}get
report/misc/notscheduledget
report/misc/notscheduled/export/{format}get
report/misc/lateorabsentget
report/misc/lateorabsent/export/{format}get
report/misc/jobsummaryget
report/misc/jobsummary/export/{format}get
report/misc/hoursworkedget
report/misc/hoursworked/export/{format}get
report/misc/tradesbyemployeeget
report/misc/tradesbyemployee/export/{format}get
report/misc/timeoffget
report/misc/timeoff/export/{format}get
report/misc/openshiftsbydateget
report/misc/openshiftsbydate/export/{format}get
report/misc/openshiftsbypositionget
report/misc/openshiftsbyposition/export/{format}get
report/misc/textmessageget
report/misc/textmessage/export/{format}get
report/misc/tradesbypositionget
report/misc/tradesbyposition/export/{format}get
report/workedhoursperdayget
report/laborcostperdayget
report/hoursworkedbypositionget
report/ataglancescheduleget
report/ataglancetimeclockget
report/shiftsperdayget
report/timesheetsperdayget
report/laborcost/timesheetsget

Requests

requests/droppost
requests/tradepost
requests/tradeshiftsget
requests/coveremployeesget
requests/coverpost

Roles

rolesget

Schedules

schedule/monthget
schedule/week/employeesget
schedule/week/positionsget
schedule/week/departmentsget
schedule/dayget
schedule/dailycoveragemapget
schedulepost
schedule/budgetget
schedule/budgetpost

TimeClock

timeclock/timesheets2get
timeclock/timesheets/export/{format}get
timeclock/putwithactivitiesput
timeclock/{timeclockId}/detailsget
timeclock/timesheetswithdetailsget

JobCodes

jobcodesget
jobcodes/{id}get

Powered by

locations/locationscount

get https://api.ximble.com/locations/locationscount

Endpoint returns a number of company locations.

Required permission: "SettingsView"

Language

Credentials