Sign in
Calendar Events

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

get/calendarEvents

Query parameters

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.

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.

Response

Successful Response

resultstring required

Example response

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

Changes

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