Sign in

v1

latestOpenAPI 3.0.02026-07-247251950.2 KB
Manage bookings

List bookings

Overview

Search for bookings by guest ID or client reference. Perfect for displaying a guest's booking history or finding bookings by your internal reference codes.

When to Use

  • Guest booking history - Show all bookings for a specific guest
  • Reference lookup - Find bookings by your internal reference codes
  • Booking management - List bookings for administrative purposes
  • Customer support - Quickly find bookings for support tickets

What You Get

  • Booking list - All matching bookings with complete details
  • Guest information - Name, email, and contact details
  • Stay details - Check-in/check-out dates and hotel information
  • Payment status - Current payment and booking status
  • Booking references - Booking IDs and confirmation codes

Search Options

  • By guest ID - Find all bookings for a specific guest
  • By client reference - Find bookings using your internal reference codes
  • By customTags - Narrow results by booking labels using customTags=KEY:VALUE,KEY2:VALUE2 (AND across keys)
  • Optional timeout - Set request timeout (default 4 seconds)

Quick Start

Provide either guestId or clientReference (or both). Returns matching bookings with full details.

get/bookings

Query parameters

clientReferencestring
guestIdstring
customTagsstring

Filter by customTags. Comma-separated KEY:VALUE pairs (e.g. SOURCE:GOOGLE,TIER:GOLD); all pairs are joined with AND. Keys must match ^[A-Z0-9_-]+$, up to 5 keys, value up to 255 characters. Value matching is case-insensitive.

timeoutnumber float

request timeout in seconds

Response

OK

Example response

{
  "data": [
    {
      "customTags": {
        "SOURCE": "GOOGLE",
        "TIER": "GOLD"
      }
    }
  ]
}