Charter Boats API
Calendar

Export iCal

Export boat calendar as iCal feed

GET/calendar/:boatId/export.ics

Get an iCal (.ics) feed for a boat's calendar. This feed includes all confirmed bookings and blocked dates, and can be subscribed to by other booking platforms.

Path Parameters

ParameterTypeRequiredDescription
boatIdstringYesThe boat's unique identifier (UUID)

Request

curl https://charter.boats/api/calendar/550e8400-e29b-41d4-a716-446655440000/export.ics

Response

Returns an iCal file with text/calendar content type.

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Charter Boats//Calendar Export//EN
CALSCALE:GREGORIAN
METHOD:PUBLISH
X-WR-CALNAME:Luxury Catamaran - Charter Boats
BEGIN:VEVENT
UID:booking-uuid-1@charter.boats
DTSTART:20260215T090000
DTEND:20260215T170000
SUMMARY:Booking - John D.
DESCRIPTION:6 guests - Birthday celebration
STATUS:CONFIRMED
END:VEVENT
BEGIN:VEVENT
UID:block-uuid-1@charter.boats
DTSTART:20260301
DTEND:20260308
SUMMARY:Owner Block - Maintenance
STATUS:CONFIRMED
END:VEVENT
END:VCALENDAR

Calendar Contents

The feed includes:

  • All confirmed bookings as VEVENT entries
  • Blocked dates (owner-blocked periods)
  • Synced events from external calendar sources

Event Properties

PropertyDescription
UIDUnique event identifier
DTSTART / DTENDEvent dates/times
SUMMARYEvent title (e.g., "Booking - John D.")
DESCRIPTIONAdditional details
STATUSEvent status (CONFIRMED, TENTATIVE)

Usage Examples

Subscribe in Google Calendar

  1. Copy the iCal URL: https://charter.boats/api/calendar/{boatId}/export.ics
  2. In Google Calendar, click + next to "Other calendars"
  3. Select "From URL"
  4. Paste the URL and click "Add calendar"

Subscribe in Apple Calendar

  1. Copy the iCal URL
  2. In Calendar app, go to File → New Calendar Subscription
  3. Paste the URL and click Subscribe

Sync with Other Platforms

Most charter platforms (Click&Boat, GetMyBoat, MMK) allow adding external iCal URLs:

  1. Find their "Calendar Sync" or "iCal Integration" settings
  2. Add the export URL as an external calendar
  3. Set sync frequency (usually 15 minutes to 1 hour)

Two-way Sync

For full two-way sync with other platforms:

  1. Export from Charter Boats: Use this endpoint URL in the other platform
  2. Import to Charter Boats: Add the other platform's iCal export URL in Dashboard → Settings → Calendars

This ensures bookings made on either platform are reflected everywhere.

Guest names are abbreviated (e.g., "John D.") in exported calendars to protect privacy while still being useful for identification.

Errors

StatusMessage
404Boat not found

On this page