IntroductionAuthenticationSelecting dataFilteringSorting & pagination

Core resources

Api requestsAttribute optionsAttributesBooking detailsBooking updatesBookingsCalendar event notesCalendar event updatesCalendar eventsCapacitiesCapacity group dependenciesCapacity groupsContact bookingsContactsCoupon productsCoupon servicesCoupon usesCouponsExternal calendars
The external calendar objectList external calendarsCreate external calendarsDelete external calendarsUpdate external calendars
InvoicesLine item taxesLine itemsMembersMessage eventsMessage templatesMessagesOrganization calendar logsOrganizationsPaddle plansPaddle subscriptionsPaymentsPermissionsPrice calendar entriesPricelabs pricingPricing widgetsProduct attribute optionsProduct calendar logsProduct message templatesProduct reply to addressesProduct servicesProductsRefundsReply to addressesReview productsReview widget listingsReview widgetsReviewsSeasonsServicesSite listingsSite nav itemsSite pagesSite viewsSitesTask assigneesTask template assigneesTask templatesTasksTaxesUser profilesWebhook notificationsWebhooksWidget analyticsWidget listingsWidgets

Booking flow

Query availabilitySearch availabilityBook

External calendars

Calendars which are being imported. Useful for syncing bookings with services like Airbnb or booking.com.

Endpoints
GET/external_calendarsPOST/external_calendarsDELETE/external_calendarsPATCH/external_calendars

The external calendar object

Attributes

iduuid

Unique identifier

product_iduuid
products.id

Identifier of the product this calendar is related to

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone | null

Timestamp at which the calendar last received new events

activeboolean

Whether the external calendar is active

errortext | null

Error message if the calendar could not be synced

event_status_sync"import" | "CONFIRMED" | "TENTATIVE"

How to treat incoming events

ical_urltext

URL of the iCal feed

last_syncedtimestamp with time zone | null

Timestamp at which the calendar was last synced

nametext | null

Name of the calendar

sync_requested_attimestamp with time zone

Timestamp at which a sync was last requested

time_offsetinteger

Time offset of the calendar in hours

tldtext

Top-level-domain of the calendar's iCal URL

The external calendar object

JSON

{
  "id": "00000000-0000-0000-0000-000000000000",
  "product_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-03-12T05:27:42.573Z",
  "updated_at": "2026-03-12T05:27:42.573Z",
  "active": true,
  "error": "",
  "event_status_sync": "import",
  "ical_url": "",
  "last_synced": "2026-03-12T05:27:42.573Z",
  "name": "",
  "sync_requested_at": "2026-03-12T05:27:42.573Z",
  "time_offset": 0,
  "tld": ""
}

List external calendars

Filters

idFilter<uuid>

Unique identifier

product_idFilter<uuid>
products.id

Identifier of the product this calendar is related to

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone | null>

Timestamp at which the calendar last received new events

activeFilter<boolean>

Whether the external calendar is active

errorFilter<text | null>

Error message if the calendar could not be synced

event_status_syncFilter<"import" | "CONFIRMED" | "TENTATIVE">

How to treat incoming events

ical_urlFilter<text>

URL of the iCal feed

last_syncedFilter<timestamp with time zone | null>

Timestamp at which the calendar was last synced

nameFilter<text | null>

Name of the calendar

sync_requested_atFilter<timestamp with time zone>

Timestamp at which a sync was last requested

time_offsetFilter<integer>

Time offset of the calendar in hours

tldFilter<text>

Top-level-domain of the calendar's iCal URL

Responses

200

A list of external calendars with the selected columns

206

Partial Content

GET /external_calendars
curl -X GET "https://api.bookingmood.com/v1/external_calendars?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create external calendars

Body

Partial<ExternalCalendar> | Array<Partial<ExternalCalendar>>

Responses

201

The newly created external calendars with the selected columns

POST /external_calendars
curl -X POST "https://api.bookingmood.com/v1/external_calendars" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete external calendars

Filters

idFilter<uuid>

Unique identifier

product_idFilter<uuid>
products.id

Identifier of the product this calendar is related to

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone | null>

Timestamp at which the calendar last received new events

activeFilter<boolean>

Whether the external calendar is active

errorFilter<text | null>

Error message if the calendar could not be synced

event_status_syncFilter<"import" | "CONFIRMED" | "TENTATIVE">

How to treat incoming events

ical_urlFilter<text>

URL of the iCal feed

last_syncedFilter<timestamp with time zone | null>

Timestamp at which the calendar was last synced

nameFilter<text | null>

Name of the calendar

sync_requested_atFilter<timestamp with time zone>

Timestamp at which a sync was last requested

time_offsetFilter<integer>

Time offset of the calendar in hours

tldFilter<text>

Top-level-domain of the calendar's iCal URL

Responses

204

The deleted external calendars with the selected columns

DELETE /external_calendars
curl -X DELETE "https://api.bookingmood.com/v1/external_calendars" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update external calendars

Filters

idFilter<uuid>

Unique identifier

product_idFilter<uuid>
products.id

Identifier of the product this calendar is related to

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone | null>

Timestamp at which the calendar last received new events

activeFilter<boolean>

Whether the external calendar is active

errorFilter<text | null>

Error message if the calendar could not be synced

event_status_syncFilter<"import" | "CONFIRMED" | "TENTATIVE">

How to treat incoming events

ical_urlFilter<text>

URL of the iCal feed

last_syncedFilter<timestamp with time zone | null>

Timestamp at which the calendar was last synced

nameFilter<text | null>

Name of the calendar

sync_requested_atFilter<timestamp with time zone>

Timestamp at which a sync was last requested

time_offsetFilter<integer>

Time offset of the calendar in hours

tldFilter<text>

Top-level-domain of the calendar's iCal URL

Body

Partial<ExternalCalendar>

Responses

204

The updated external calendars with the selected columns

PATCH /external_calendars
curl -X PATCH "https://api.bookingmood.com/v1/external_calendars" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'