Skip to content

search_bookings

Search for bookings with rich filtering, sorting, and pagination. Supports filters for status, dates, returning guests, payment, contract, vetting, building, unit, contacts, platform, and value. Returns the same operational booking shape as get_booking, including external references, occupancy, move-in/out scheduling, allocation, and cancelation and termination request details.

Parameter Type Required Description
first number No Number of results to return (forward pagination). Maximum 25. Use with “after” for paging.
after string No Cursor for forward pagination. Pass the “endCursor” from previous page’s pageInfo.
last number No Number of results to return (backward pagination). Maximum 25. Use with “before” for reverse paging.
before string No Cursor for backward pagination. Pass the “startCursor” from previous page’s pageInfo.
filters BookingsFiltersInput No Filter criteria for the booking search. Supports complex queries with AND/OR logic. - BookingsFiltersInput
sort BookingsSortInput No Sort order for results. Defaults to newest first if not specified. - BookingsSortInput
Field Type Required Description
arrivedAt DateTimeFilter No DateTimeFilter
departedAt DateTimeFilter No DateTimeFilter
building BuildingFilter No BuildingFilter
checkIn DateTimeFilter No DateTimeFilter
checkOut DateTimeFilter No DateTimeFilter
confirmedAt DateTimeFilter No DateTimeFilter
confirmationCode StringFilter No StringFilter
createdAt DateTimeFilter No DateTimeFilter
externalBookingId StringFilter No StringFilter
externalListingId StringFilter No StringFilter
isReturningGuest BooleanFilter No Filter by whether the lead guest has a previous booking. - BooleanFilter
updatedAt DateTimeFilter No DateTimeFilter
contacts ContactFilter No ContactFilter
id StringFilter No StringFilter
numberOfGuests NumberFilter No NumberFilter
numberOfNights NumberFilter No NumberFilter
platform StringFilter No StringFilter
status BookingStatusFilter No BookingStatusFilter
unit UnitFilter No UnitFilter
vettingStatus VettingStatusFilter No VettingStatusFilter
vettingSource VettingSourceFilter No VettingSourceFilter
vettingSupervised VettingSupervisedFilter No VettingSupervisedFilter
vettingProviderStatus VettingProviderStatusFilter No VettingProviderStatusFilter
vettingUpdatedAt DateTimeFilter No DateTimeFilter
cancelationRequests CancelationRequestsFilter No CancelationRequestsFilter
terminationRequests TerminationRequestsFilter No TerminationRequestsFilter
paymentStatus PaymentStatusFilter No PaymentStatusFilter
downPaymentStatus DownPaymentStatusFilter No DownPaymentStatusFilter
contractStatus ContractStatusFilter No ContractStatusFilter
value NumberFilter No NumberFilter
sepaMandateStatus SepaMandateStatusFilter No SepaMandateStatusFilter
plannedArrival TimeFilter No TimeFilter
plannedDeparture TimeFilter No TimeFilter
workspace WorkspaceFilter No WorkspaceFilter
Field Type Required Description
id SortDirection No Sort by booking ID - SortDirection
createdAt SortDirection No Sort by creation date (use DESC for newest first) - SortDirection
updatedAt SortDirection No Sort by last-updated date (use DESC for recently modified first) - SortDirection
vettingUpdatedAt SortDirection No Sort by the date vetting was last updated (use DESC for recently vetted first) - SortDirection
Field Type Required Description
eq string No Equals: exact datetime match (ISO8601 format, e.g., “2026-01-15T14:30:00Z”)
neq string No Not equals: exclude exact datetime
in string[] No In: match any datetime in the array
nin string[] No Not in: exclude datetimes in the array
lt string No Less than: before this datetime (exclusive)
lte string No Less than or equal: before or at this datetime (inclusive)
gt string No Greater than: after this datetime (exclusive)
gte string No Greater than or equal: after or at this datetime (inclusive)
Field Type Required Description
id StringFilter No Filter by building ID - StringFilter
Field Type Required Description
eq string No Equals: exact match
neq string No Not equals: exclude exact match
in string[] No In: match any value in the array
nin string[] No Not in: exclude values in the array
search string No Full-text search: partial/fuzzy match
Field Type Required Description
eq boolean No Equals: exact boolean match
neq boolean No Not equals: exclude boolean match
Field Type Required Description
contact ContactDetailFilter No Filter by the contact details - ContactDetailFilter
role ContactRoleFilter No Filter by the contact role on the booking - ContactRoleFilter
status ContactStatusFilter No Filter by the contact status (new vs returning) - ContactStatusFilter
Field Type Required Description
eq number No Equals: exact match
neq number No Not equals: exclude exact match
in number[] No In: match any value in the array
nin number[] No Not in: exclude values in the array
gt number No Greater than (exclusive)
gte number No Greater than or equal (inclusive)
lt number No Less than (exclusive)
lte number No Less than or equal (inclusive)
Field Type Required Description
eq BookingStatusType No Equals: exact booking status match - BookingStatusType
neq BookingStatusType No Not equals: exclude booking status - BookingStatusType
in BookingStatusType[] No In: match any booking status in the array - BookingStatusType
nin BookingStatusType[] No Not in: exclude booking statuses in the array - BookingStatusType
Field Type Required Description
id StringFilter No Filter by unit ID
code StringFilter No Filter by unit code
address UnitAddressFilter No Filter by unit address - UnitAddressFilter
Field Type Required Description
eq VettingStatusType No Equals: exact vetting status match - VettingStatusType
neq VettingStatusType No Not equals: exclude vetting status - VettingStatusType
in VettingStatusType[] No In: match any vetting status in the array - VettingStatusType
nin VettingStatusType[] No Not in: exclude vetting statuses in the array - VettingStatusType
Field Type Required Description
eq VettingSource No Equals: exact vetting source match - VettingSource
neq VettingSource No Not equals: exclude vetting source - VettingSource
in VettingSource[] No In: match any vetting source in the array - VettingSource
nin VettingSource[] No Not in: exclude vetting sources in the array - VettingSource
Field Type Required Description
eq VettingSupervised No Equals: exact supervised vetting outcome match - VettingSupervised
neq VettingSupervised No Not equals: exclude supervised vetting outcome - VettingSupervised
in VettingSupervised[] No In: match any supervised vetting outcome in the array - VettingSupervised
nin VettingSupervised[] No Not in: exclude supervised vetting outcomes in the array - VettingSupervised
Field Type Required Description
eq VettingProviderStatus No Equals: exact vetting provider status match - VettingProviderStatus
neq VettingProviderStatus No Not equals: exclude vetting provider status - VettingProviderStatus
in VettingProviderStatus[] No In: match any vetting provider status in the array - VettingProviderStatus
nin VettingProviderStatus[] No Not in: exclude vetting provider statuses in the array - VettingProviderStatus
Field Type Required Description
status ApprovalRequestStatusFilter No Filter by the status of the booking cancelation request(s) - ApprovalRequestStatusFilter
Field Type Required Description
status ApprovalRequestStatusFilter No Filter by the status of the booking termination request(s) - ApprovalRequestStatusFilter
Field Type Required Description
eq PaymentStatusType No Equals: exact payment status match - PaymentStatusType
neq PaymentStatusType No Not equals: exclude payment status - PaymentStatusType
in PaymentStatusType[] No In: match any payment status in the array - PaymentStatusType
nin PaymentStatusType[] No Not in: exclude payment statuses in the array - PaymentStatusType
Field Type Required Description
eq DownPaymentStatusType No Equals: exact down payment status match - DownPaymentStatusType
neq DownPaymentStatusType No Not equals: exclude down payment status - DownPaymentStatusType
in DownPaymentStatusType[] No In: match any down payment status in the array - DownPaymentStatusType
nin DownPaymentStatusType[] No Not in: exclude down payment statuses in the array - DownPaymentStatusType
Field Type Required Description
eq ContractStatusType No Equals: exact contract status match - ContractStatusType
neq ContractStatusType No Not equals: exclude contract status - ContractStatusType
in ContractStatusType[] No In: match any contract status in the array - ContractStatusType
nin ContractStatusType[] No Not in: exclude contract statuses in the array - ContractStatusType
Field Type Required Description
eq SepaMandateStatus No Equals: exact SEPA mandate status match - SepaMandateStatus
neq SepaMandateStatus No Not equals: exclude SEPA mandate status - SepaMandateStatus
in SepaMandateStatus[] No In: match any SEPA mandate status in the array - SepaMandateStatus
nin SepaMandateStatus[] No Not in: exclude SEPA mandate statuses in the array - SepaMandateStatus
Field Type Required Description
eq string No Equals: exact local time match (HH:mm or HH:mm:ss)
neq string No Not equals: exclude exact time
in string[] No In: match any time in the array
nin string[] No Not in: exclude times in the array
lt string No Less than: before this time (exclusive)
lte string No Less than or equal: before or at this time (inclusive)
gt string No Greater than: after this time (exclusive)
gte string No Greater than or equal: after or at this time (inclusive)
Field Type Required Description
id StringFilter No Filter by workspace ID
Field Type Required Description
firstName StringFilter No Filter by contact first name
lastName StringFilter No Filter by contact last name
primaryEmail StringFilter No Filter by contact primary email
Field Type Required Description
eq ContactRole No Equals: exact contact role match - ContactRole
neq ContactRole No Not equals: exclude contact role - ContactRole
in ContactRole[] No In: match any contact role in the array - ContactRole
nin ContactRole[] No Not in: exclude contact roles in the array - ContactRole
Field Type Required Description
eq ContactStatus No Equals: exact contact status match - ContactStatus
neq ContactStatus No Not equals: exclude contact status - ContactStatus
in ContactStatus[] No In: match any contact status in the array - ContactStatus
nin ContactStatus[] No Not in: exclude contact statuses in the array - ContactStatus
Field Type Required Description
postcode StringFilter No Filter by postcode
Field Type Required Description
eq ApprovalRequestStatus No Equals: exact approval request status match - ApprovalRequestStatus
neq ApprovalRequestStatus No Not equals: exclude approval request status - ApprovalRequestStatus
in ApprovalRequestStatus[] No In: match any approval request status in the array - ApprovalRequestStatus
nin ApprovalRequestStatus[] No Not in: exclude approval request statuses in the array - ApprovalRequestStatus
Value Description
ASC
DESC
Value Description
AWAITING_PAYMENT
CANCELED
CLOSED
CONFIRMED
DECLINED
EXPIRED
INQUIRY
REQUESTED
RESERVED
TENTATIVE
TENTATIVE_EXPIRED
TERMINATED
Value Description
FAILED
IN_PROCESS
PASSED
PENDING
REVIEW
Value Description
AUTOHOST Autohost
CHEKIN Chekin
IN_HOUSE In House
Value Description
APPROVE
DECLINE
Value Description
PENDING
REVIEW
VERIFIED
Value Description
CANCELED
DISPUTED
DISPUTE_REVERSED
DUE
EXPIRED
FAILED
IN_PROCESS
OVERDUE
REVERSED
SUCCESS
Value Description
COMPLETED
PENDING
REFUNDED
Value Description
COMPLETED
PENDING
VOIDED
Value Description
COMPLETED
FAILED
NOT_SET_UP
PENDING
Value Description
AGENT
GUARANTOR
GUEST
LEAD_GUEST
SIGNATORY
Value Description
NEW
RETURNING
Value Description
APPROVED
DECLINED
PENDING
WITHDRAWN
Field Type Description
content ContentItem[] Array of content items returned by the tool - ContentItem
isError boolean Whether the tool execution resulted in an error
Field Type Description
type 'text' Content type (currently only ‘text’ is supported)
text string The text content to display