Search bookings by text

Overview

Search for bookings by free-text query. Matches guest names, booking IDs, hotel names, and other booking-related fields. Results are paginated.

When to Use

  • Admin or support lookup - Find bookings by guest name, hotel name, or partial ID
  • Text search - Search across multiple fields with a single query string
  • Paginated results - Control page size and page index via request body

What You Get

  • Matching bookings - List of bookings matching the query with key fields
  • Pagination - page, rowsPerPage, and the search query echoed back
  • Credit line billing - When applicable, billing info (credit line ID, billed amount USD, billed at date, payment ID)

Request Body

  • query (required) - Text to search for (e.g. guest name, hotel name, booking ID)
  • page - Zero-based page index (default 0)
  • rowsPerPage - Number of results per page (e.g. 5)
  • sand_box - Filter by environment (e.g. "false" for production)

Quick Start

POST a JSON body with query, page, and rowsPerPage. Response includes data array, success, and pagination fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Text to search for (guest name, hotel name, booking ID, etc.).

integer
Defaults to 0

Zero-based page index for pagination.

integer

Number of results per page.

string

Filter by sandbox environment (e.g. "true" or "false").

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json