v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Reservations

Returns a list of reservations for a given profile

get/profiles/{profileId}/reservations

Path parameters

profileIdnumber required

Example:226973

Profile ID

Query parameters

filterstring

Filter criteria in the format field:operation:value;field:operation:value.

field: The field name to filter on.
operation: The operation to apply (e.g., equals, not_equals, greater_than, less_than).
value: The value to filter by. Value is not required for some operations, like is_null. Multiple filters can be separated by semicolons (;).

sortstring

Example:name:asc,age

Sorting criteria in one of the following formats:

field1:asc,field2:desc - Sorts by field1 in ascending order and field2 in descending order.
field1,field2 - Sorts by field1 and field2 in ascending order.
Combination of both formats is allowed. Each field can be specified with asc (ascending) or desc (descending) if ordering is needed.

offsetnumber

The number of items to skip before starting to collect the result set.

limitnumber

Example:100

The maximum number of items to return in the response.

includeTotalboolean

Example:true

Use true to get total in the response

Headers

X-Organization-Idstring required

Organization ID

Response

offsetinteger

limitinteger

Example response

{
  "limit": 100,
  "data": [
    {
      "id": "91009944",
      "externalId": "8236866345079",
      "hasBalance": true,
      "checkInAt": "2024-01-13",
      "checkOutAt": "2024-01-15",
      "createdAt": "2024-03-03T14:21:26+00:00",
      "updatedAt": "2024-08-29T15:19:16+00:00",
      "totals": {
        "nights": 2,
        "rooms": 1,
        "guests": 1,
        "adults": 1
      },
      "amounts": {
        "totalDue": 160,
        "grandTotal": 160
      },
      "property": {
        "id": "226768",
        "name": "Handcrafted data-warehouse"
      },
      "source": {
        "id": "1147922",
        "parentId": "1",
        "otaId": "0",
        "code": "s-1",
        "name": "Website/Booking Engine",
        "isHotelCollectBooking": true,
        "createdAt": "2024-03-03T14:21:05+00:00",
        "updatedAt": "2024-03-03T14:21:05+00:00"
      },
      "reservationStatus": "confirmed",
      "guests": [
        {
          "id": "88204789",
          "firstName": "Cathari",
          "lastName": "Marks",
          "email": "cathari.marks@cloudbeds.com",
          "birthday": "1900-09-16",
          "phone": "+1 (366) 836-9964",
          "cellPhone": "+1 (212) 457-7093",
          "taxId": "276",
          "isMainGuest": true,
          "address": {
            "country": "HM",
            "state": "Heard Island and McDonald Islands",
            "city": "Sint fuga Nostrum i",
            "address1": "853 Fabien Court",
            "address2": "Est sapiente tempor",
            "zip": "42212"
          },
          "document": {
            "type": "dni"
          },
          "company": {
            "taxId": "Whitehead Kennedy Traders",
            "name": "Jackson and Stewart Inc"
          }
        }
      ],
      "rooms": [
        {
          "id": "122898135",
          "typeId": "524846",
          "typeName": "kingType",
          "guestId": "88204789",
          "rateId": "1850620",
          "subReservationId": "8236866345079",
          "totalNights": 2,
          "totalAdults": 1,
          "totalGuests": 1,
          "checkInAt": "2024-01-13",
          "checkOutAt": "2024-01-15",
          "status": "not_checked_in",
          "createdAt": "2024-03-03T14:21:26+00:00",
          "updatedAt": "2024-03-03T14:21:26+00:00"
        }
      ]
    }
  ]
}