Skip to content

fluent-booking/list-bookings

List bookings with filters. Returns a compact row per booking; attendee emails are masked unless include_pii is set. Use get-booking for one booking in full.

Ability

  • Kind: Tool
  • Toolset: core
  • Edition: Core
  • Mode: read-only
  • Permission callback: PermissionGate::readGate()
  • Handler: BookingTools::listBookings()
  • Source: fluent-booking/app/Modules/MCP/Tools/BookingTools.php:41

Input schema

ParameterTypeRequiredDescription
periodstringNoComputed bucket. Defaults to upcoming.
statusarray<string>NoFilter by raw status values instead of a period bucket.
calendar_idintegerNo
event_idintegerNo
event_typestringNo
host_idintegerNo
emailstringNoExact attendee email match.
searchstringNoFree-text search across attendee name, email and phone.
fromstringNoStart of the booking date range, Y-m-d.
tostringNoEnd of the booking date range, Y-m-d.
timezonestringNoIANA timezone for the *_local times in the response. Defaults to the site timezone.
group_bookingsbooleanNoCollapse group bookings to one row, matching the admin list. Default true.
include_piibooleanNoReturn unmasked attendee emails. Requires read access to all bookings.
pageintegerNo
per_pageintegerNo

Example call

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "fluent-booking/list-bookings",
    "arguments": {}
  }
}