Schedule

Lists the jobs scheduled to start within a date range as calendar events.

Times are the organization's local wall clock with no zone suffix (2026-09-08T00:00:00); a trailing Z is converted to local time first. The window may span at most 92 days. Events are not paginated — a quarter of jobs is returned in one array. Response carries a weak ETag; resend it as If-None-Match to get 304 when nothing changed. Also available as CSV (Accept: text/csv or ?format=csv).

get/api/v1/schedule

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/schedule
  • Auth: HTTP bearer

Query parameters

fromstring date-time

Inclusive start of the window (required). Example: 2026-09-01T00:00:00.

tostring date-time

Inclusive end of the window (required), at most 92 days after from. Example: 2026-09-30T23:59:59.

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

Calendar events ordered as the service returns them (by job).

idinteger

Job id — fetch details with GET /api/v1/jobs/{id}.

titlestring

Event title: job number and customer, plus the description on a second line when present. Example: J-2026-0042 - Acme Property.

startstring

Start as the organization's local wall-clock time, yyyy-MM-ddTHH:mm:ss with no zone suffix. Example: 2026-09-08T08:30:00.

endstring

End (start + duration), same format as start.

urlstring nullable

Relative API path of the job. Example: /api/v1/jobs/1042.

backgroundColorstring

Hex colour for the event body, derived from the job status. Example: #28a745.

borderColorstring

Hex colour for the event border (currently equal to backgroundColor).

displayTimestring

Start time formatted for display. Example: 8:30 AM.

Changes

No recorded changes to this operation across all 1 revision of this API.