Raw schema
{
"type": "object",
"properties": {
"filter": {
"type": "string",
"enum": [
"arrivals",
"departures",
"new",
"current"
]
},
"propertyIds": {
"description": "One or more property ids.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"roomIds": {
"description": "One or more room ids.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"bookingIds": {
"description": "One or more booking ids.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"masterIds": {
"description": "One or more group master booking ids.",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"apiReferences": {
"description": "Channel / API references.",
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"channel": {
"description": "Only bookings from this channel.",
"type": "string",
"enum": [
"agoda",
"airbnb",
"asiatravel",
"atraveode",
"booking",
"bookingpage",
"despegar",
"direct",
"edreamsodigeo",
"expedia",
"feratel",
"goibibo",
"hometogo",
"hostelworld",
"hotelbeds",
"hrs",
"jomres",
"marriott",
"ostrovokru",
"ota",
"tiket",
"tomastravel",
"traveloka",
"travia",
"traum",
"trip",
"tripadvisorrentals",
"vacationstay",
"vrbo",
"airbnbical",
"bedandbreakfasteu",
"bedandbreakfastnl",
"bookeasycomau",
"bookitconz",
"flipkey",
"googlecal",
"googleads",
"guestlinkcouk",
"holidaylettingscouk",
"hostelinternational",
"hostelsclub",
"housetripcom",
"icalimport1",
"icalimport2",
"icalimport3",
"lastminute",
"nzaa",
"reserva",
"rezintelnet",
"tablethotels",
"traumferienwohnungen",
"trivagocom",
"visitscotlandcom",
"vrboical",
"webroomsconz"
]
},
"status": {
"description": "Statuses to include. Defaults to all except cancelled.",
"type": "array",
"items": {
"type": "string",
"enum": [
"confirmed",
"request",
"new",
"cancelled",
"black",
"inquiry"
]
}
},
"arrival": {
"description": "Exact arrival date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"arrivalFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date, YYYY-MM-DD."
},
"arrivalTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date, YYYY-MM-DD."
},
"departure": {
"description": "Exact departure date.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"departureFrom": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date, YYYY-MM-DD."
},
"departureTo": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "Date, YYYY-MM-DD."
},
"bookingTimeFrom": {
"description": "Booked after this time (UTC).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"
},
"bookingTimeTo": {
"description": "Booked before this time (UTC).",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"
},
"modifiedFrom": {
"description": "Modified after this time.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"
},
"modifiedTo": {
"description": "Modified before this time.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$"
},
"searchString": {
"description": "Matches guest name, email, apiReference or booking id.",
"type": "string"
},
"includeInvoiceItems": {
"type": "boolean"
},
"includeInfoItems": {
"type": "boolean"
},
"includeGuests": {
"description": "Include additional guests (bookings-personal scope).",
"type": "boolean"
},
"includeBookingGroup": {
"type": "boolean"
},
"page": {
"description": "Page number beyond the first (2, 3, ...). Check pages.nextPageExists in the previous response.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}