1. Reservation
YellowStone
  • Getting Started
    • Introduction
    • Quick Start
    • Authentication
    • General
    • Changelog
  • APIs
    • Booking
      • Post Booking
    • Inventory
      • Get Inventory Locations
      • Get Inventory Item
    • PacesetterItinerary
      • Get Guest Itinerary
    • Reservation
      • Get Reservations
        POST
      • Get Reservations For Pacesetter
        GET
    • Sale
      • Post Sale
    • Schemas
      • Address
      • Addresses
      • AlertRequest
      • ContactInfo
      • ApiResponse
      • ContactInfos
      • DateRange
      • Description
      • Emails
      • GetProperty
      • GetRatePlans
      • Error
      • GetRatesAvailability
      • FetchReservation
      • GetRoomType
      • GetInventoryItemResponse
      • GuestRoom
      • GetInventoryItemResponseListApiResponse
      • HotelDescriptiveContents
      • HotelInfo
      • HotelProperty
      • InquiryCorrespondence
      • InquiryInterest
      • InquiryTag
      • Name
      • Names
      • Occupancy
      • Phone
      • Phones
      • Position
      • InventoryLocationSetup
      • PostActivitiesBookedHostsRequest
      • InventoryLocationSetupListApiResponse
      • PostActivitiesBookedLocationsRequest
      • PostActivitiesBookedRatesRequest
      • PostActivitiesBookedRequest
      • PostActivitiesBookedResourceRequest
      • PacesetterItineraryCombinedDetails
      • PostBookingParametersRequest
      • PacesetterItineraryCombinedDetailsApiResponse
      • PostCancellationFeeRequest
      • PacesetterItineraryOverview
      • PostCorrespondenceToBeSentRequest
      • PacesetterItineraryRoomStay
      • PostGuestsRequest
      • PacesetterItineraryScheduleItem
      • PostInquiryRequest
      • PacesetterReservation
      • PostPaymentDetailsRequest
      • PacesetterReservationListApiResponse
      • PostPrimaryGuestDetailsRequest
      • PacesetterVisitingGuest
      • PostRatesRequest
      • PostRequest
      • PostRoomsBookedRequest
      • Prices
      • PropertyResponse
      • RBSCMConnectItem
      • RatePlan
      • RatePlanDescription
      • RatePlanResponse
      • RatePlansContainer
      • Rates
      • RatesAvailabilityResponse
      • ReservationCMRequest
      • ReservationRequest
      • Room
      • RoomDates
      • RoomInfo
      • RoomTypeResponse
      • PostRequestApiResponse
      • Rooms
      • SaveExternalPurchaseItemRequest
      • SellableProduct
      • SellableProducts
      • UpdateFetchQueueMessageRequest
      • ReservationResponse
      • ReservationResponseApiResponse
      • SaveExternalPurchaseRequest
      • SaveExternalPurchaseRequestApiResponse
  1. Reservation

Get Reservations

POST
https://api.rbsapps.com/api/Reservation/GetReservations
Returns a paginated list of reservations (50 per page) with guest, room and status details.
Sample request:
POST /api/Reservation/GetReservations
{
"arrivalDate": { "startDate": "2026-10-01", "endDate": "2026-10-07" },
"reservationStatus": "BOOKED",
"pageNo": 1
}
POST /api/Reservation/GetReservations
{ "reservationNumber": "10452" }
Notes:
Date ranges longer than 7 days are shortened to 7 days from the start date.
A reservation number with a suffix (for example "10452-1") is matched on the part before the hyphen.
Status values: BOOKED, CANCELLED, CHECKED_IN, CHECKED_OUT.
pageNo defaults to 1. When nothing matches, the response is 200 with an empty list.

Request

Authorization
API Key
Add parameter in header
X-API-Key
Example:
X-API-Key: ********************
or
Body Params application/json

Example
{
    "clientId": 0,
    "reservationNumber": "string",
    "reservationID": 0,
    "arrivalDate": {
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z"
    },
    "departureDate": {
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z"
    },
    "reservationStatus": "string",
    "fetchHotelKey": "string",
    "pageNo": 0
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.rbsapps.com/api/Reservation/GetReservations' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": 0,
    "reservationNumber": "string",
    "reservationID": 0,
    "arrivalDate": {
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z"
    },
    "departureDate": {
        "startDate": "2019-08-24T14:15:22.123Z",
        "endDate": "2019-08-24T14:15:22.123Z"
    },
    "reservationStatus": "string",
    "fetchHotelKey": "string",
    "pageNo": 0
}'

Responses

🟢200
application/json
Returns the matching reservations (may be empty)
Bodyapplication/json

Example
{
    "content": {
        "data": [
            {
                "reservationID": 0,
                "reservationNumber": "string",
                "clientID": 0,
                "guestID": 0,
                "firstName": "string",
                "lastName": "string",
                "bookingDate": "string",
                "arrivalDate": "string",
                "departureDate": "string",
                "statusType": "string",
                "status": "string",
                "reservationType": "string",
                "email": "string",
                "phoneNumber": "string",
                "countryCode": "string",
                "countryPhoneCode": "string",
                "notes": "string",
                "hotelID": "string",
                "hotelKey": "string",
                "roomID": "string",
                "roomName": "string",
                "roomNo": "string",
                "floorNo": "string",
                "roomLocationName": "string",
                "currentPage": 0,
                "fetchQueueMessageId": 0
            }
        ],
        "totalRows": 0,
        "totalRowsPerPage": 0,
        "currentPage": 0
    },
    "errors": [
        {
            "code": "string",
            "description": "string"
        }
    ],
    "message": "string",
    "success": true
}
🟠401
🔴500
Modified at 2026-10-08 09:12:29
Previous
Get Guest Itinerary
Next
Get Reservations For Pacesetter
Built with