resos_list_bookings
List bookings
List bookings, newest or oldest first as you sort, with date, time, party size, status, the guest's name, e-mail and phone, assigned tables and custom-field answers. Filter by date range, status, party size or guest name. The comment thread and sent-message log are not included (use resos_get_booking for the thread). Pages of at most 100; pass next_skip to read on. GET /bookings.
Parametersskipsortlimitpeoplestatuscustom_queryto_date_timefrom_date_timeonly_confirmedguest_name_contains
resos_get_booking
Get booking
One booking by id, with the guest's contact data, tables, custom fields, payment, the comment thread (guest and restaurant messages) and the internal restaurant notes. GET /bookings/{id}.
Parametersbooking_idrequired
resos_list_customers
List customers
List the restaurant's customers (guest profiles): name, e-mails, phones, city and country, tags, notes, flags, booking count and newsletter consent. The street address is not returned. Filter by name. Pages of at most 100. GET /customers.
Parametersskiplimitcustom_queryname_contains
resos_get_customer
Get customer
One customer (guest profile) by id: contact data, tags, notes, flags, booking count and latest booking. GET /customers/{id}.
Parameterscustomer_idrequired
resos_list_guest_feedback
List guest feedback
List guest feedback (ratings for food, service, value and atmosphere, whether they recommend, and the message). Filter by date range, or only submitted feedback. Pages of at most 100. GET /guestFeedback.
Parametersskipsortlimitcustom_queryto_date_timefrom_date_timeonly_submitted
resos_get_guest_feedback
Get guest feedback
One guest feedback entry by id. GET /guestFeedback/{id}.
Parametersfeedback_idrequired
resos_list_seating_areas
List seating areas and tables
List the seating areas with their tables (id, name, minimum and maximum seats) and table combinations. Use the ids for bookings and availability. GET /tables.
Takes no parameters.
resos_list_opening_hours
List opening hours
List the opening hours: regular weekly hours (day 1 Monday to 7 Sunday) and special date-specific hours, each with id, name, open and close times and whether the restaurant is open. GET /openingHours.
Parameterssorttypeonly_specialshow_deleted
resos_get_opening_hour
Get opening hour
One opening-hour entry by id. GET /openingHours/{id}.
Parametersopening_hour_idrequired
resos_list_custom_fields
List custom fields
List the custom booking fields (name, label, type, required, choices). Use the ids to read or set custom-field answers. GET /customFields.
Takes no parameters.
resos_get_custom_field
Get custom field
One custom booking field by id. GET /customFields/{id}.
Parameterscustom_field_idrequired
resos_get_available_dates
Get available dates
Dates in a range on which the restaurant is open for bookings (default: the next 30 days). GET /bookingFlow/dates.
Parametersto_datefrom_date
resos_get_available_times
Get available times
Booking times that are free on a date for a party size, optionally for one seating area. GET /bookingFlow/times.
Parametersdatepeoplerequiredarea_idonly_bookable_online
resos_get_available_tables
Get available tables
The tables and table combinations that are free for a party size in a time window (UTC). Use it before assigning tables to a booking. GET /bookingFlow/availableTables.
Parameterspeoplerequiredarea_idto_date_timerequiredfrom_date_timerequiredreturn_all_tablesexclude_booking_idonly_bookable_online
resos_create_booking
Create booking
WRITE: create a booking for a guest. It is a real booking in the restaurant's book. If notify_email or notify_sms is true, resOS e-mails or texts the GUEST (a confirmation); both default to false. Date and time are in the restaurant's local timezone. Check resos_get_available_times first: resOS may refuse a slot that is full or closed. It is not retried: if the call times out, read the bookings before you try again, or you may book twice. resOS may silently throttle the same e-mail, phone or IP creating more than 10 bookings in 24 hours. POST /bookings.
Parametersdaterequirednotetimerequiredpeoplerequiredstatusarea_idcommentdurationtable_idsguest_namerequirednotify_smsguest_email+3 more
resos_update_booking
Update booking
WRITE: change fields of an existing booking: date, time, party size, tables, duration, status, or the guest's name, e-mail or phone. Only the fields you pass change. A status change or a new time can make resOS e-mail or text the GUEST (for example on approved or declined). To cancel use resos_cancel_booking. It is not retried: after a timeout read the booking again before you try again. PUT /bookings/{id}.
Parametersdatetimepeoplestatusdurationtable_idsbooking_idrequiredguest_nameguest_emailguest_phone
resos_cancel_booking
Cancel booking
WRITE: cancel a booking (status canceled, with a canceled-at time). resOS may e-mail or text the GUEST a cancellation notice. The booking stays in resOS and can be read afterwards. Not retried: after a timeout read the booking first. PUT /bookings/{id}/cancel.
Parametersbooking_idrequired
resos_add_booking_note
Add internal booking note
WRITE: add an internal restaurant note to a booking (for example `Birthday, bring a candle`). The guest does not see it and nothing is sent. At most 50 notes per booking; notes cannot be deleted through the API. Not retried: after a timeout read the booking first, or the note may be added twice. POST /bookings/{id}/restaurantNote.
Parameterstextrequiredbooking_idrequired