Introduction

Core resources

Administration

Invite member

Revoke member

Booking flow

Bookings

Endpoints

GET/bookingsPOST/bookingsDELETE/bookingsPATCH/bookings

The booking object

Attributes

iduuid

Unique identifier

organization_iduuid

Identifier of the organization this booking is defined in

site_iduuid | null

sites.id

Identifier of the site this booking was made on

widget_iduuid | null

widgets.id

Identifier of the widget this booking was made in

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

confirmed_attimestamp with time zone | null

Timestamp at which the booking was confirmed

currencytext

Base currency of the booking

display_currencytext

Currency used to display prices to the customer

exchange_ratereal

Exchange rate used to convert the booking currency to the display currency

methodtext

Method used to make the booking, request or book

occupancyjsonb

Occupancy per occupancy group. Formatted as Record<occupancy_group_id, occupancy>

referencetext

Publicly visible reference of the booking

secrettext

Secret reference of the booking

silentboolean

Whether the booking was made without automatically sending a confirmation email

The booking object

{"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"site_id": "00000000-0000-0000-0000-000000000000",
"widget_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-11-21T14:08:29.839Z",
"updated_at": "2024-11-21T14:08:29.839Z",
"confirmed_at": "2024-11-21T14:08:29.839Z",
"currency": "",
"display_currency": "",
"exchange_rate": 0,
"method": "request",
"occupancy": {},
"reference": "",
"secret": "extensions.uuid_generate_v4()",
"silent": false
}

List bookings

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this booking is defined in

site_idFilter<>

Identifier of the site this booking was made on

widget_idFilter<>

Identifier of the widget this booking was made in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

confirmed_atFilter<>

Timestamp at which the booking was confirmed

currencyFilter<>

Base currency of the booking

display_currencyFilter<>

Currency used to display prices to the customer

exchange_rateFilter<>

Exchange rate used to convert the booking currency to the display currency

methodFilter<>

Method used to make the booking, request or book

occupancyFilter<>

Occupancy per occupancy group. Formatted as Record<occupancy_group_id, occupancy>

referenceFilter<>

Publicly visible reference of the booking

secretFilter<>

Secret reference of the booking

silentFilter<>

Whether the booking was made without automatically sending a confirmation email

Responses

200

A list of bookings with the selected columns

206

Partial Content

GET/bookings

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

Create bookings

Body

Partial<Booking>
 | Array<Partial<Booking>>

Responses

201

The newly created bookings with the selected columns

POST/bookings

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

Delete bookings

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this booking is defined in

site_idFilter<>

Identifier of the site this booking was made on

widget_idFilter<>

Identifier of the widget this booking was made in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

confirmed_atFilter<>

Timestamp at which the booking was confirmed

currencyFilter<>

Base currency of the booking

display_currencyFilter<>

Currency used to display prices to the customer

exchange_rateFilter<>

Exchange rate used to convert the booking currency to the display currency

methodFilter<>

Method used to make the booking, request or book

occupancyFilter<>

Occupancy per occupancy group. Formatted as Record<occupancy_group_id, occupancy>

referenceFilter<>

Publicly visible reference of the booking

secretFilter<>

Secret reference of the booking

silentFilter<>

Whether the booking was made without automatically sending a confirmation email

Responses

204

The deleted bookings with the selected columns

DELETE/bookings

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

Update bookings

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this booking is defined in

site_idFilter<>

Identifier of the site this booking was made on

widget_idFilter<>

Identifier of the widget this booking was made in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

confirmed_atFilter<>

Timestamp at which the booking was confirmed

currencyFilter<>

Base currency of the booking

display_currencyFilter<>

Currency used to display prices to the customer

exchange_rateFilter<>

Exchange rate used to convert the booking currency to the display currency

methodFilter<>

Method used to make the booking, request or book

occupancyFilter<>

Occupancy per occupancy group. Formatted as Record<occupancy_group_id, occupancy>

referenceFilter<>

Publicly visible reference of the booking

secretFilter<>

Secret reference of the booking

silentFilter<>

Whether the booking was made without automatically sending a confirmation email

Body

Partial<Booking>

Responses

204

The updated bookings with the selected columns

PATCH/bookings

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