schedule.list

A shop's visits that overlap a time window, earliest first. Filter by worker, job, or only mine. Field workers only ever see their own. A lead sees the crews they belong to or lead. Shop roles are owner, office, lead and field.

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

When to use it

A shop's visits that overlap a time window, earliest first. Filter by worker, job, or only mine.

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
fromstring (date-time)yes
tostring (date-time)yes
person_idstring (uuid)no
job_idstring (uuid)no
minebooleanno
unassignedbooleanno
include_cancelledbooleanno

Example

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

Output

FieldTypeAlways there
time_zonestringyes
summarystringyes
displayobjectyes
display.kindstring (one of table, cards, timeline, checklist, map, calendar, chart)yes
display.titlestringyes
display.columnsarrayno
display.columns[].keystringyes
display.columns[].labelstringyes
display.fieldsarrayno
display.fields[].keystringyes
display.fields[].labelstringyes
itemsarrayyes
items[].visit_idstring (uuid)yes
items[].shop_idstring (uuid)yes
items[].job_idstring (uuid)yes
items[].job_summary['string', 'null']yes
items[].starts_atstring (date-time)yes
items[].ends_atstring (date-time)yes
items[].title['string', 'null']yes
items[].notes['string', 'null']yes
items[].statusstring (one of scheduled, on_the_way, arrived, started, done, cancelled)yes
items[].cancel_reason['string', 'null']yes
items[].series_id['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']yes
items[].started_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].done_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].done_note['string', 'null']yes
items[].prioritystringyes
items[].arrival_window_minutes['integer', 'null']yes
items[].arrive_bystring (date-time)yes
items[].on_the_way_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].eta_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].arrived_at['string', 'null', ' ', '(', 'd', 'a', 't', 'e', '-', 't', 'i', 'm', 'e', ')']yes
items[].assignee_idsarrayyes
truncatedbooleanyes
{
  "time_zone": "...",
  "summary": "...",
  "display": {
    "kind": "table",
    "title": "..."
  },
  "items": [
    {
      "visit_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "job_id": "00000000-0000-4000-8000-000000000000",
      "job_summary": "...",
      "starts_at": "...",
      "ends_at": "...",
      "title": "...",
      "notes": "...",
      "status": "scheduled",
      "cancel_reason": "...",
      "series_id": "00000000-0000-4000-8000-000000000000",
      "started_at": "...",
      "done_at": "...",
      "done_note": "...",
      "priority": "...",
      "arrival_window_minutes": "...",
      "arrive_by": "...",
      "on_the_way_at": "...",
      "eta_at": "...",
      "arrived_at": "...",
      "assignee_ids": [
        "00000000-0000-4000-8000-000000000000"
      ]
    }
  ],
  "truncated": true
}

Errors

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