Bookings are short-term reservation of resource. Bookings can reserve any resource, such as Meeting Room, Hot desk, Private Office, etc.
Here is the list of most properties the booking object has:
Booking
Property | Type | Required | Description |
---|---|---|---|
start.dateTime | date | true | Start datetime of the booking in ISO date time format |
end.dateTime | date | true | End datetime of the booking in ISO date time format |
serviceSlots,before | number | false | Allows you to create a buffer slot before the booking takes place. The time is measure in minutes. |
serviceSlots.after | number | false | Allows you to create a buffer slot after the booking takes place. The time is measure in minutes. |
timezone | string | readonly | The booking resource timezone |
source | string | false | The origin/source of the booking |
summary | string | false | Booking title/summary |
resourceId | id | true | Reference to the booked resource |
team | Team | false | Reference to the company (required if no member) |
member | Employee | false | Reference to the member (required if no team) |
description | string | false | Long description of the booking |
canceled | boolean | readonly | Whether the booking got canceled or not. It also can be passed when calling the /summary endpoint. |
recurrence.rrule | string | false | Determines 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 |
createdAt | date | readonly | The date when the booking has been created. |
createdBy | id | readonly | The user that created the booking. |
modifiedAt | date | readonly | The user that did the last modification to the booking. If no update is made this field will match the createdBy field. |
modifiedBy | id | readonly | The user that did the last modification to the booking. Before the first modification, this field equals to the createdBy field. |