Bookings

Bookings are short-term reservation of resource. Bookings can reserve any resource, such as Meeting Room, Hot desk, Private Office, etc.

πŸ“˜

Note

In order to use the requests in this collection, you need to authenticate to the API with your username and password by using this request.

Here is the list of most properties the booking object has:

Booking

PropertyTypeRequiredDescription
start.dateTimedatetrueStart datetime of the booking in ISO date time format.
end.dateTimedatetrueEnd datetime of the booking in ISO date time format.
serviceSlots,beforenumberfalseAllows you to create a buffer slot before the booking takes place. The time is measure in minutes.
serviceSlots.afternumberfalseAllows you to create a buffer slot after the booking takes place. The time is measure in minutes.
timezonestringreadonlyThe booking resource timezone.
sourcestringfalseThe origin/source of the booking.
summarystringfalseBooking title/summary.
resourceIdResourcetrueReference to the booked resource.
planRatesreadonlyReference to the resource rate used for the booking.
teamCompanyfalseReference to the company (required if no member).
memberMemberfalseReference to the member (required if no team).
descriptionstringfalseLong description of the booking.
tentativebooleanfalseTrue if the booking is not confirmed. Tentative booking are not charged.
freebooleanfalseTrue if the booking is marked as free. If create a booking marked as free, no fees will be added for it.
feesarrayreadonlyArray of items describing how the booking will be charged for. Described below as BookingFee.
extrasobjectreadonlyDictionary with keys the IDs of the extras to add to the booking and values - the quantity of the extra
visitorsarrayfalseCan be populated with ids of visitors created using this endpoint.
membersarrayfalseCan be populated with ids of members from the same company, if there's a "team" associated with the booking.
canceledbooleanreadonlyWhether the booking got canceled or not. It also can be passed when calling the /summary endpoint.
recurrence.rrulestringfalseDetermines if the booking is recurring. The "FREQ" can be daily/weekly/monthly and "UNTIL" is the end date of recurrence.

Example: "FREQ=DAILY;UNTIL=20220117T230000Z"
createdAtdatereadonlyThe date when the booking has been created.
createdByidreadonlyThe user that created the booking.
modifiedAtdatereadonlyThe user that did the last modification to the booking. If no update is made this field will match the createdBy field.
modifiedByidreadonlyThe user that did the last modification to the booking. Before the first modification, this field equals to the createdBy field.

Booking Fee

PropertyTypeRequiredDescription
datedatetrueThe date of the occurrence the fee has been generated for
feeFeefalseThe actual charge generated for this occurrence.
creditsarraytrueThe credits used for the booking
extraFeesarray(Fee)trueArray of fees generated for the extras.