Calendar Events

GET /calendarEvents

Returns a list of CalendarEvents. The list can be filtered by user name, event type or active events only.

Request

Base URL
https://api.fergus.com
Auth
- OAuth 2
  Authorization codehttps://auth.fergus.com/oauth2/authorize
  Token URLhttps://auth.fergus.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/fergus/apis/fergus-api/docs/calendarEvents/get.ts
A function with typed inputs. Its response is checked against the schema.

filterCalendarEventType'JOB_PHASE' | 'QUOTE' | 'ESTIMATE' | 'OTHER'

filterUserIdnumber

filterJobIdnumber

filterJobPhaseIdnumber

filterJobEventsOnlyboolean

filterNonJobEventsOnlyboolean

filterUnassignedEventsOnlyboolean

filterActiveOnlyboolean

filterDateFromstring date-time

The start date for filtering calendar events, in ISO 8601 format.

The time portion is discarded only the date is used.
A timezone offset (+/-HH:MM or +/-HHMM) is expected to ensure accurate timezone interpretation.
If none is provided, the value will be treated as UTC.

Defaults to the current day if not provided.

filterCalendarRange'DAY' | 'THREE_DAY' | 'WEEK' | 'FORTNIGHT' | 'MONTH'

The filterDateFrom (or currentDate if not provided) sets the start of the period.

For DAY and THREE_DAY options, it's that exact date.
For WEEK and MONTH options, it's the week or month that includes that date (weeks run Monday to Sunday).
For FORTNIGHT option, it starts at the Monday of the week that contains that date.

This defaults to WEEK if not provided.

Successful Response

resultstring required

{
  "data": [
    {
      "startTime": "2021-01-01T07:00:00.000Z",
      "endTime": "2021-01-01T17:00:00.000Z"
    }
  ]
}

Oct 20, 20269c2e89ccdd2b Revision changes
- breaking
  for the query request parameter filterDateFrom, default value 2026-10-16T00:00:00.000+13:00 was removed
Oct 15, 2026018f5c4af739 Revision changes
- breaking
  for the query request parameter filterDateFrom, default value was changed from 2026-10-09T00:00:00.000+13:00 to 2026-10-16T00:00:00.000+13:00