1. Guests
WinCloud API
  • Getting Started
    • Introduction
    • Quick Start
    • Authentication
    • General
    • Changelog
    • Privacy Policy
    • Terms of Service
    • Support
  • APIs
    • Guests
      • Search Guests
        GET
      • Create Guest
        POST
      • Get Guest Details
        GET
      • Update Guest
        PATCH
      • Get Guest Reservations
        GET
      • Get Guest Reference Data
        GET
    • Inventory
      • Get Room Inventory
      • Get Room Inventory Details
      • Update Room Inventory
    • Properties
      • Get Customer Properties
      • Get Property Configuration
    • Rates
      • Get Rate Adjustment Templates
      • Get Master Rates
      • Post Master Rates
      • Post Individual Rates
    • Reference Data
      • Get Countries
      • Get Payment Gateways
      • Get Payment Methods
      • Get Currencies
    • Reservations v1
      • Get Reservations
      • Get Cancelled Reservations
      • Get No-Show Reservations
      • Get Reservation Statuses
      • Update Special Instructions
    • Reservations v2
      • List Reservations
      • Get Reservation
    • Rooms
      • Get Rooms
      • Get Room Types
      • Get Rooms Extra Charges
      • Get Rooms Feature Types
      • Get Rooms Tariffs
      • Get Room and Revenue Performance
    • Travel Agents
      • Get Active Travel Agents
    • POS
      • Get Outlet Menu
    • Booking Analytics
      • Get Arrival Summary
      • Get Booking Summary
    • Schemas
      • CodeNameDto
      • ArrivalFiguresDto
      • CompanyDto
      • ArrivalSummaryDto
      • CompanyDtoPaginatedResponse
      • ArrivalSummaryDtoApiResponse
      • CompanyDtoPaginatedResponseApiResponse
      • BookingSummaryDto
      • CountryDto
      • ConfigurationOutletDto
      • BookingSummaryDtoApiResponse
      • CountryDtoApiResponse
      • ConfigurationRoomTypeDto
      • CountryRefDto
      • CurrencyDto
      • CurrencyDtoPaginatedResponse
      • CurrencyDtoPaginatedResponseApiResponse
      • ExtraChargeDto
      • ExtraChargeDtoApiResponse
      • FeatureTypeDto
      • CurrencyRefDto
      • FeatureTypeDtoPaginatedResponse
      • FeatureTypeDtoPaginatedResponseApiResponse
      • GuestCreatedDto
      • GuestAddressDto
      • GuestCreatedDtoApiResponse
      • GuestLookupsDto
      • GuestLookupsDtoApiResponse
      • DepartureFiguresDto
      • GuestPhoneDto
      • GuestPreferencesDto
      • GuestProfileDtoApiResponse
      • GuestProfileDto
      • GuestReservationDtoPaginatedResponse
      • GuestReservationDtoPaginatedResponseApiResponse
      • GuestStaySummaryDto
      • GuestReservationDto
      • GuestProfileRequestDto
      • GuestSummaryItemDto
      • GuestSummaryItemDtoPaginatedResponse
      • GuestPassportDto
      • GuestSummaryItemDtoPaginatedResponseApiResponse
      • InventoryRoomTypeDto
      • InventorySnapshotDto
      • InventorySnapshotDtoPaginatedResponse
      • InventorySnapshotDtoPaginatedResponseApiResponse
      • LanguageRefDto
      • MasterRateBlockDto
      • MasterRateTypeDto
      • MasterRateTypeDtoPaginatedResponse
      • MasterRateTypeDtoPaginatedResponseApiResponse
      • LinkedGuestDto
      • MealPlanDto
      • ObjectApiResponse
      • PayMethodDto
      • PayMethodDtoPaginatedResponse
      • OtaReferenceDto
      • PayMethodDtoPaginatedResponseApiResponse
      • PaymentGatewayDto
      • PaymentGatewayDtoPaginatedResponse
      • PaymentGatewayDtoPaginatedResponseApiResponse
      • ProblemDetails
      • PosMenuItemDto
      • RateAdjustmentTemplateDto
      • PosMenuItemDtoPaginatedResponse
      • RateAdjustmentTemplateDtoPaginatedResponse
      • PosMenuItemDtoPaginatedResponseApiResponse
      • RateAdjustmentTemplateDtoPaginatedResponseApiResponse
      • RatePlanRefDto
      • RecentReservationsDto
      • ReservationBillingDto
      • ReservationCancellationDto
      • PropertyConfigurationDto
      • ReservationEventDtoPaginatedResponse
      • PropertyConfigurationDtoApiResponse
      • ReservationEventDtoPaginatedResponseApiResponse
      • ReservationSourceDto
      • ReservationStatusDto
      • ReservationDtoApiResponse
      • ReservationDtoListApiResponse
      • ReservationStatusDtoListApiResponse
      • ReservationDtoPaginatedResponse
      • ReservationStayStatusDto
      • ReservationDtoPaginatedResponseApiResponse
      • RoomAssignmentItemDto
      • ReservationBookingDto
      • RoomCheckInDto
      • RoomCheckOutDto
      • RoomDto
      • RoomDtoPaginatedResponse
      • RoomDtoPaginatedResponseApiResponse
      • ReservationEventDto
      • RoomInventoryUpdateRequestDto
      • RoomInventoryUpdateResponseDto
      • RoomInventoryUpdateResponseDtoApiResponse
      • RoomRateDto
      • ReservationDto
      • RoomRateDtoPaginatedResponse
      • RoomRateDtoPaginatedResponseApiResponse
      • ReservationRoomDto
      • RoomRateFailureDto
      • RoomRateItemDto
      • RoomRateUpdateRequestDto
      • RoomRateUpdateResponseDto
      • RoomRateUpdateResponseDtoApiResponse
      • ReservationGuestDto
      • RoomTypeDto
      • ReservationOccupancyDto
      • RoomTypeDtoPaginatedResponse
      • RoomTypeDtoPaginatedResponseApiResponse
      • RoomTypeRefDto
      • StaySpendDto
      • TemplateDateRangeDto
      • TitleRefDto
      • TravelAgentDto
      • RoomPerformanceComparisonDto
      • TravelAgentDtoPaginatedResponse
      • RoomPerformanceMetricsDto
      • TravelAgentDtoPaginatedResponseApiResponse
      • RoomPerformancePeriodDto
      • UpdateMasterRatesRequestDto
      • RoomPerformanceResponseDto
      • UpdateMasterRatesResultDto
      • RoomPerformanceResponseDtoApiResponse
      • UpdateMasterRatesResultDtoApiResponse
      • UpdateReservationRequestDto
      • UpdateReservationResponseDtoApiResponse
      • RoomTypePerformanceDto
      • UpdateReservationResponseDto
      • SpecialRequestsDto
  • MCP
    • Overview
    • Connect Your AI Assistant
  • Webhooks
    • Set Up and Edit Webhooks
    • Verify Webhook Signatures
    • List of Webhook Events
  1. Guests

Get Guest Details

GET
https://uat-api.wincloudone.com/stdinterface/api/v1/guests/{guestId}
Guests
Last modified:2026-10-21 10:15:36
Retrieves one guest's full profile. Email and mobile are returned unmasked here.
GET /api/v1/guests/10234?companyId=HT&stayLimit=5

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Query Params

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://uat-api.wincloudone.com/stdinterface/api/v1/guests/?companyId=&stayLimit=' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Returns the guest profile
Body

Example
{
    "success": true,
    "message": "string",
    "errorCode": "string",
    "statusCode": 0,
    "data": {
        "guestId": 0,
        "title": {
            "code": "string",
            "name": "string"
        },
        "guestName": "string",
        "email": "string",
        "mobile": "string",
        "phone": {
            "residence": "string",
            "office": "string"
        },
        "address": {
            "line1": "string",
            "line2": "string",
            "line3": "string",
            "postalCode": "string"
        },
        "nationality": {
            "code": "string",
            "name": "string",
            "isoCode": "string"
        },
        "countryOfResidence": {
            "code": "string",
            "name": "string",
            "isoCode": "string"
        },
        "language": {
            "code": "string",
            "name": "string"
        },
        "isPreferredGuest": true,
        "preferences": {
            "likes": "string",
            "dislikes": "string",
            "favouriteRoom": "string",
            "hotelComment": "string",
            "notes": [
                "string"
            ]
        },
        "summary": {
            "completedStays": 0,
            "totalNights": 0,
            "noShowCount": 0,
            "cancellationCount": 0,
            "firstStayDate": "2019-08-24T14:15:22.123Z",
            "lastStayDate": "2019-08-24T14:15:22.123Z"
        },
        "recentReservations": {
            "returned": 0,
            "totalCount": 0,
            "hasMore": true,
            "items": [
                {
                    "reserveNo": 0,
                    "bookingNo": 0,
                    "onlineBookingRefNo": "string",
                    "booking": {
                        "reservationDate": "2019-08-24T14:15:22.123Z",
                        "arrivalDate": "2019-08-24T14:15:22.123Z",
                        "arrivalTime": "string",
                        "departureDate": "2019-08-24T14:15:22.123Z",
                        "departureTime": "string",
                        "nights": 0,
                        "roomsBooked": 0,
                        "currency": {
                            "code": "string",
                            "name": "string",
                            "isoCode": "string"
                        },
                        "bookedBy": "string",
                        "contactEmail": "string",
                        "contactMobile": "string",
                        "contactTelephone": "string",
                        "depositAmount": 0,
                        "totalRoomRate": 0
                    },
                    "occupancy": {
                        "adults": 0,
                        "children": 0,
                        "infants": 0,
                        "pax": 0
                    },
                    "guestsOnStay": 0,
                    "roomType": {
                        "code": "string",
                        "name": "string"
                    },
                    "reservedRoom": "string",
                    "rooms": [
                        {
                            "registrationNo": 0,
                            "roomNo": "string",
                            "guestId": 0,
                            "roomType": {
                                "code": "string",
                                "name": "string"
                            },
                            "ratePlan": {
                                "planId": "string",
                                "planName": "string",
                                "rateTypeId": "string",
                                "rateTypeName": "string"
                            },
                            "occupancy": {
                                "adults": 0,
                                "children": 0,
                                "infants": 0,
                                "pax": 0
                            },
                            "checkIn": {
                                "date": "2019-08-24T14:15:22.123Z",
                                "time": "string",
                                "by": "string",
                                "arrivalFrom": "string",
                                "arrivalFlight": "string"
                            },
                            "checkOut": {
                                "date": "2019-08-24T14:15:22.123Z",
                                "time": "string",
                                "departTo": "string",
                                "departureFlight": "string",
                                "instructions": "string"
                            }
                        }
                    ],
                    "ratePlan": {
                        "planId": "string",
                        "planName": "string",
                        "rateTypeId": "string",
                        "rateTypeName": "string"
                    },
                    "status": {
                        "bookingStatus": "string",
                        "cancellation": {
                            "cancellationNo": 0,
                            "date": "2019-08-24T14:15:22.123Z",
                            "reason": "string",
                            "requestedBy": "string",
                            "cancelledBy": "string"
                        }
                    },
                    "source": {
                        "channel": "string",
                        "businessSourceId": "string",
                        "businessSourceName": "string",
                        "marketSegmentId": "string",
                        "marketSegmentName": "string",
                        "reservationModeId": "string",
                        "reservationModeName": "string",
                        "travelAgentId": "string",
                        "travelAgentName": "string"
                    },
                    "billing": {
                        "totalBilled": 0,
                        "tariff": 0,
                        "otherSales": 0,
                        "taxes": 0,
                        "discount": 0,
                        "totalPaid": 0,
                        "outstandingAmount": 0,
                        "totalReceived": 0,
                        "paymentStatus": "string",
                        "spend": {
                            "frontOffice": 0,
                            "pointOfSale": 0,
                            "total": 0
                        }
                    },
                    "specialRequests": {
                        "reservationInstructions": "string",
                        "instructions": "string",
                        "foInstruction": "string",
                        "posInstruction": "string",
                        "guestSpecialRequest": "string",
                        "message": "string",
                        "remarks": "string"
                    }
                }
            ]
        }
    },
    "timestamp": "2019-08-24T14:15:22.123Z",
    "correlationId": "string"
}
🟠400
🟠401
🟠403
🟠404
🔴500
Modified at 2026-10-21 10:15:36
Previous
Create Guest
Next
Update Guest
Built with