Calendars

List calendars

Retrieve a list of all calendars for the authenticated alias. This endpoint supports pagination and returns calendars in CalDAV format.

get/v1/calendars

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/calendars
  • Auth: HTTP basic

Query parameters

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

Calendars retrieved successfully

idstring required

Calendar ID (calendarId from CalDAV)

namestring required

Calendar name

descriptionstring required

Calendar description

colorstring required

Calendar color (hex format)

timezonestring required

Calendar timezone

orderinteger required

Calendar display order

created_atstring date-time required
updated_atstring date-time required
object'calendar' required

Example response

[
  {
    "id": "calendar123",
    "name": "Personal Calendar",
    "description": "My personal calendar",
    "color": "#ff0000",
    "timezone": "America/New_York",
    "order": 0,
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z",
    "object": "calendar"
  }
]

Changes

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