Private preview of the new site. Not live.

schedule.settings

The shop's scheduling setup: time zone, booking hours (or the default when none are set), arrival window, travel buffer, reminder lead time, and whether on-my-way notices go out. Any worker in the shop can read it.

WhoAgents can call this
RESTGET /v1/schedule/settings
MCP toolschedule_settings
Writesno
AreaScheduling and visits

When to use it

Read schedule.settings first: it has the shop's time zone, working hours, arrival window and buffer. Use schedule.findTime to get open times that fit the shop's hours, each worker's hours and time off, and visits already booked with the buffer around them, then book with visits.create.

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

FieldTypeRequired
shop_idstring (uuid)yes

Example

GET https://doingwork.work/v1/schedule/settings?shop_id=00000000-0000-4000-8000-000000000000

Output

FieldTypeAlways there
shop_idstring (uuid)yes
time_zonestringyes
time_zone_setbooleanno
hoursarrayyes
hours[].weekdayintegeryes
hours[].startstringyes
hours[].endstringyes
hours_sourcestring (one of shop, default)yes
arrival_window_minutesintegeryes
buffer_minutesintegeryes
reminder_hoursintegeryes
on_my_way_noticesbooleanyes
{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "time_zone": "...",
  "hours": [
    {
      "weekday": 1,
      "start": "...",
      "end": "..."
    }
  ],
  "hours_source": "shop",
  "arrival_window_minutes": 1,
  "buffer_minutes": 1,
  "reminder_hours": 1,
  "on_my_way_notices": true
}

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.