API Documentation

Returns schedule events that overlap a time window. Prefer this over ScheduleEvent/get with start/end filters when answering "what's on the schedule today/this week" questions - contained-in-window filters (start_time >= and end_time <=) miss events that span the window edges.

Times on ScheduleEvent are stored in UTC. Convert local calendar-day boundaries to UTC before calling (e.g. America/Toronto during EDT: local midnight-to-midnight is about YYYY-MM-DD 04:00:00 UTC through the next day 04:00:00 UTC).

Required parameters (top-level request fields, not inside filters):

• start_time: (datetime string) Window start in UTC, e.g. 2026-10-05 04:00:00
• end_time: (datetime string) Window end in UTC, e.g. 2026-10-06 04:00:00

Optional parameters:

• filters: Same JSON filter array shape as /get (see Getting/Filtering). AND-only - or filters are rejected on this endpoint. Do not put the day window in filters; use the required start_time / end_time params. Comparison operators belong in the field string: ["job_id", 123] or ["start_time >=", "..."] - never ["start_time", ">=", "..."] or ["start_time", "...", "and", ">="].
• include: Related resources (commonly Job, User, Service)
• fields: Lean field list for the parent and/or included records

Example - company schedule for one local day (EDT), with project and employee names:

GET ScheduleEvent/get-range
{
  "start_time": "2026-10-05 04:00:00",
  "end_time": "2026-10-06 04:00:00",
  "include": ["Job", "User"],
  "fields": ["id", "job_id", "user_id", "start_time", "end_time", "is_vacation"]
}

Then keep rows whose included Job.customer_id (or service customer) matches a named customer, and skip vacation / non-work rows when the question is about working on projects.