Schedule
Get the schedule for a range
Returns the consolidated schedule of a window: projects, orders, tasks, internal services and order services.
schedule:readschedule:read- 120/min
- Server annotation: Read-only
- Server annotation: Idempotent
Result
generated from the schema
It does not paginate: it is bounded by dates, which is what a calendar asks for, but each layer is capped and the response does not say when it was cut: at most 200 projects, 200 orders and 500 tasks, ordered by start date, so a layer that returns exactly its cap may be truncated (use a shorter window). Only active records appear: projects in draft, budgeted, confirmed or in_progress, and orders in draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned or checked_in_partially; a checked_in, cancelled or archived order is not returned. It is therefore not a complete snapshot: do not delete a record only because it is missing. Assignees come out by identifier and name; their contact details do not.
Arguments
Window start, in ISO 8601 with offset.
Window end, in ISO 8601 with offset.
Which layers to fetch: projects, orders, tasks, internal_services or order_services. By default, everything. Repeat the parameter or separate the values with commas for several.
Available options: projects, orders, tasks, internal_services, order_services
Limits: min 1 items, max 50 items
Filter projects by status.
Limits: min 1 items, max 50 items
Filter orders by status.
Limits: min 1 items, max 50 items
Keep only what is assigned to these staff members.
Limits: min 1 items, max 200 items
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Projects that fall within the window.
Show child attributesHide child attributes
Orders that fall within the window.
Show child attributesHide child attributes
Schedule tasks. Without the contact data of whoever they are assigned to.
Show child attributesHide child attributes
Show child attributesHide child attributes
Staff member identifier.
Name shown in the schedule.
Assignments not attached to an order.
Show child attributesHide child attributes
Show child attributesHide child attributes
Staff member identifier.
Name shown in the schedule.
Staff and fleet services attached to an order.
Show child attributesHide child attributes
Show child attributesHide child attributes
Staff member identifier.
Name shown in the schedule.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
Sample prompts
What is on the calendar between Monday and Friday?
The same operation by REST
This tool runs GET /api/v1/schedule.
Related pages
Link to this section: Related pagesSchedule
Get the schedule for a range
Returns the consolidated schedule of a window: projects, orders, tasks, internal services and order services.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?