Skip to content

Highlights

Briefing of who’s coming in and what to watch for on a single date. Returns counts + grouped lists for first-timers, VIPs (5+ prior visits), guests with allergies, dietary preferences, birthdays, anniversaries, and reservations carrying special notes. Use this when the operator asks an open-ended question like ‘what’s tonight?’, ‘anyone allergic today?’, ‘any birthdays?’, ‘any first-timers?’, ‘who’s worth a manager visit?’. For specific filters (e.g. ‘who’s allergic to fish?’) prefer list_bookings with include=[“guest”,“history”].

Required scope: bookings.read

Parameter Type Required Description
brand string no Brand slug. Optional in JWT mode; required in multi-brand API-key mode.
date string no Target date in YYYY-MM-DD (brand local TZ). Defaults to today in the brand timezone.
vipMinVisits number no Visit-count threshold for the VIP group. Default 5.