HotSchedule API

Does HotSchedule have a public API?

HotSchedules exposes APIs to integration partners through Fourth's developer hub, and credentials arrive only after the mutual customer requests them through a Fourth representative, one set per third party. An operator's own engineering team has no self-serve route. Integuru generates a production-ready HTTP API for HotSchedule from your own login, with 9 verified actions across schedules, punches, timecards, labor reports and the employee roster.

What you can do with the HotSchedule API

A regional manager over nine stores wants Sunday night's schedule for next week, Monday morning's view of who clocked in, and Friday's timecards for payroll. The actions follow the week.

Push the schedule out

• get_schedules returns the schedule for a store_id, defaulting to the current week Monday through Sunday, with report_type selecting the schedule view.
• get_all_staff_scheduled_shifts returns every scheduled shift for a required store_id across a Monday-to-Sunday window of at most seven days.

Watch the floor

• get_current_clocked_in_employees returns who is punched in at a store_id for a business_date that defaults to today in the store's timezone.

Close payroll

• get_timecards returns timecards for a required store_id and pay period, start_date defaulting to the latest period start, pay_period_type selecting the frequency.
• get_timecard_summary rolls the period up across the same options.
• get_report runs a labor report by report_type over a date range for store_ids or a group_id.

Know the roster

• list_employees and get_employee_profiles return staff, the latter filterable to one store_id; list_stores returns the store identifiers every other action uses.

Who uses this

Payroll and tip-pooling tools pull get_timecards per store each pay period and match punches to the sales they pulled from the POS pages, such as Square or Heartland. Labor forecasting tools compare get_all_staff_scheduled_shifts against actual hours from get_timecard_summary to score schedule accuracy per store. Groups with mixed scheduling systems run this page beside Sling by Toast, SocialSchedules and 7shifts through the same Integuru workflow. The restaurants industry page covers scheduling, tips and payroll together.

Setup notes

Integuru authenticates against app.hotschedules.com with your HotSchedules user. Call list_stores first; store_id is required on get_all_staff_scheduled_shifts, get_current_clocked_in_employees and get_timecards, and optional elsewhere. Align weekly ranges to Monday and Sunday, and keep get_all_staff_scheduled_shifts to seven days per call. Dates are YYYY-MM-DD.

Get started

Install the CLI and connect your HotSchedule login:

npm install -g integuru

Or sign in at app.integuru.com, add HotSchedule, and call the same 9 actions from the dashboard. For shift writes, availability or time-off actions, the Managed Service scopes and builds them against your account.