Schedule Tools
Week-level scheduling operations: copy a week's shifts to another week, save and load schedule templates, and get insights into hours, booking demand, and understaffing gaps.
Required scope: staff:read for read operations, staff:write for write operations.
Tools Overview
| Tool | Description | Read-only? |
|---|---|---|
list_schedule_templates | List saved schedule templates | Yes |
get_schedule_insights | Get scheduled hours and coverage gaps for a week | Yes |
get_booking_demand | Get per-day rental and experience booking counts | Yes |
get_understaffing_warnings | Flag days with bookings but no staff scheduled | Yes |
copy_schedule_week | Copy every shift from one week to another | No |
save_schedule_template | Save a week's shifts as a named template | No |
load_schedule_template | Apply a saved template to a target week | No |
delete_schedule_template | Delete a saved schedule template | No |
list_schedule_templates
List all saved schedule templates for the supplier.
Parameters
None.
Response Fields
Returns a templates array. Each entry includes id, name, shift_count, and created_at.
get_schedule_insights
Get scheduled hours, staff count, per-staff hour breakdown, and coverage gaps for a week.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
week_start | string | No | Any date in the target week (YYYY-MM-DD). Defaults to the current week. |
Response Fields
Returns total scheduled hours, number of staff scheduled, a per-staff breakdown of hours, and a list of days with identified coverage gaps.
get_booking_demand
Get per-day rental booking counts and experience session participant totals for a date range. Use alongside get_schedule_insights to correlate demand with staffing levels.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
start_date | string | Yes | Range start (YYYY-MM-DD) |
end_date | string | Yes | Range end (YYYY-MM-DD) |
Response Fields
Returns a demand array keyed by date. Each entry includes rental booking count and experience participant totals for that day.
get_understaffing_warnings
Flag days that have bookings but no staff scheduled, and experience sessions that are missing an assigned guide.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
start_date | string | Yes | Range start (YYYY-MM-DD) |
end_date | string | Yes | Range end (YYYY-MM-DD) |
Response Fields
Returns a warnings array. Each warning includes the date, the type of issue (no_staff_scheduled or guide_missing), and relevant context such as the experience name or booking count.
copy_schedule_week
Copy every shift from a source week to a target week. Both week_start values should be a Monday.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
source_week_start | string | Yes | Source week Monday (YYYY-MM-DD) |
target_week_start | string | Yes | Target week Monday (YYYY-MM-DD) |
include_staff | boolean | No | Default true — copy staff assignments too. Set to false to copy shift times only (open shifts). |
overwrite | boolean | No | Default false — when true, deletes existing target-week shifts before copying. |
Response Fields
Returns success and a summary of the copy operation including the number of shifts created.
save_schedule_template
Snapshot a week's shifts as a named reusable template. Templates can be loaded onto any future week with load_schedule_template.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
week_start | string | Yes | Source week Monday (YYYY-MM-DD) |
name | string | Yes | Template name |
Response Fields
Returns success and a template object with id and name.
load_schedule_template
Apply a saved schedule template to a target week, creating shifts from the template's saved pattern.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
template_id | integer | Yes | Template ID to load |
target_week_start | string | Yes | Target week Monday (YYYY-MM-DD) |
overwrite | boolean | No | Default false — when true, deletes existing target-week shifts before applying the template. |
Response Fields
Returns success and a summary of shifts created.
delete_schedule_template
Delete a saved schedule template. This is destructive and requires explicit user confirmation.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
template_id | integer | Yes | Template ID to delete |
user_confirmed | boolean | Yes | Must be true — user must confirm deletion |
Response Fields
Returns success: true on deletion, or an error if the template was not found.
Related
- Staff Tools - Individual shift creation and management
- Time Off Tools - View approved time off before scheduling
- Experiences Tools - Guide assignment for experience slots
- Staff REST API - REST API endpoints for staff and scheduling