---
title: "GET /calendarEvents"
method: GET
path: "/calendarEvents"
tags: ["Calendar Events"]
---

# GET /calendarEvents

`GET /calendarEvents`

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

## Query parameters

- `filterCalendarEventType` 'JOB_PHASE' | 'QUOTE' | 'ESTIMATE' | 'OTHER'
- `filterUserId` number
- `filterJobId` number
- `filterJobPhaseId` number
- `filterJobEventsOnly` boolean
- `filterNonJobEventsOnly` boolean
- `filterUnassignedEventsOnly` boolean
- `filterActiveOnly` boolean
- `filterDateFrom` string, date-time
- `filterCalendarRange` 'DAY' | 'THREE_DAY' | 'WEEK' | 'FORTNIGHT' | 'MONTH'

## Response `200`

Successful Response

- CalendarEventsResponse
  - `result` string, required
  - `data` CalendarEvent[], required
    - `id` number, required
    - `companyId` number, required
    - `userId` number, nullable, required
    - `userName` string, nullable, required
    - `groupId` number, nullable, required
    - `title` string, required
    - `description` string, nullable, required
    - `eventType` 'JOB_PHASE' | 'QUOTE' | 'ESTIMATE' | 'OTHER', required
    - `jobPhaseId` number, nullable, required
    - `jobId` number, nullable, required
    - `startTime` string, date-time, required — The start time of the calendar event in ISO string format in 15 minute intervals
    - `endTime` string, date-time, required — The end time of the calendar event in ISO string format in 15 minute intervals
    - `isActive` boolean, required
    - `isAllDay` boolean, required
    - `isRecurring` boolean, required
    - `recurringEventDetails` RecurringEventDetails, required
      - `startDate` string, date-time, required
      - `endDate` string, date-time, nullable, required
      - `rRule` string, required
      - `text` string, required
    - `createdAt` string, date-time, required
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)