Calendar Events

List calendar events

Retrieve a list of calendar events for the authenticated alias. This endpoint supports pagination and filtering by calendar, date range, and deletion status.

get/v1/calendar-events

Request

Base URL: https://api.forwardemail.net
URL: https://api.forwardemail.net/v1/calendar-events
Auth: HTTP basic

Query parameters

calendar_idstring

Filter events by calendar ID

start_datestring date-time

Filter events starting from this date (ISO 8601 format)

end_datestring date-time

Filter events ending before this date (ISO 8601 format)

include_deletedboolean

Include soft-deleted events in results

pageinteger

Page of results to return. If not specified, value will be 1. Must be a number greater than or equal to 1.

limitinteger

Number of results to return per page. Defaults to 25 if not specified. Must be a number greater than or equal to 1, and less than or equal to 100.

Response

List of calendar events

idstring required

Calendar event ID (eventId from CalDAV)

calendar_idstring required

ID of the calendar this event belongs to

icalstring required

iCalendar (RFC 5545) data for the event

summarystring

Event title/summary (extracted from iCal data)

descriptionstring

Event description (extracted from iCal data)

locationstring

Event location (extracted from iCal data)

start_datestring date-time

Event start date/time (extracted from iCal data)

end_datestring date-time

Event end date/time (extracted from iCal data)

uidstring

Unique identifier from iCal data

statusstring

Event status (extracted from iCal data)

organizerstring

Event organizer (extracted from iCal data)

deleted_atstring date-time nullable

Soft deletion timestamp

created_atstring date-time required

updated_atstring date-time required

object'calendar_event' required

Example response

[
  {
    "id": "event123",
    "calendar_id": "calendar123",
    "ical": "BEGIN:VCALENDAR\nVERSION:2.0\nPRODID:-//Example Corp//Example Calendar//EN\nBEGIN:VEVENT\nUID:event123@example.com\nDTSTART:20250101T120000Z\nDTEND:20250101T130000Z\nSUMMARY:Example Event\nDESCRIPTION:This is an example event\nLOCATION:Conference Room A\nSTATUS:CONFIRMED\nEND:VEVENT\nEND:VCALENDAR",
    "summary": "Example Event",
    "description": "This is an example event",
    "location": "Conference Room A",
    "start_date": "2025-01-01T12:00:00.000Z",
    "end_date": "2025-01-01T13:00:00.000Z",
    "uid": "event123@example.com",
    "status": "CONFIRMED",
    "organizer": null,
    "deleted_at": null,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "object": "calendar_event"
  }
]

Changes

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