In-house guests

The only resource of the hotspot integration. Returns room, identity and check-in/check-out details for every guest currently in house (checked in, not yet checked out). The hotspot software fetches this list at regular intervals and opens or closes Wi-Fi accounts accordingly; the steps are described in the Guest verification flow guide.

POST/public/json/customer/inhotelList in-house guests

Object#

Fields

uniqueinteger

Stay record ID, unique per guest and reservation. Use it as the user / session key on the hotspot side.

rezervasyon_idinteger

Reservation ID. Guests sharing a room share this value.

inHotelinteger

1 = the guest is in house. Always 1, since the endpoint returns in-house guests only.

firstNamestring

First name. Usually upper case, as read from the ID document; multiple given names are space-separated.

lastNamestring

Last name. Usually upper case.

identityNumberstring | null

Turkish ID number or passport number as printed on the document. May be empty for guests registered without ID details.

birthDatestring | null

Date of birth, DD.MM.YYYY. May be empty.

roomIDinteger

The room’s HMS ID.

roomNamestring

Room name / number as the guest sees it on the door and key card. Ask for this as the “room number” on the portal.

checkininteger

Guest check-in time as a Unix timestamp (seconds).

checkoutinteger

Planned check-out date as a Unix timestamp at the start of the day (00:00 UTC); it carries no time of day. Add the hotel’s check-out time (usually 12:00) to get the session end.

checkout2integer | null

Actual check-out time. null for in-house guests; a guest who checks out drops off the list anyway.

mikrotikSifrelemeinteger

The Mikrotik encryption setting of the room’s building in HMS: 0 room name (the Wi-Fi password is the room number), 1 no password. Apply the same policy on your own portal.

01

Sample object

{
    "mikrotikSifreleme": 0,
    "unique": 58211,
    "inHotel": 1,
    "identityNumber": "11111111110",
    "firstName": "AYŞE",
    "lastName": "DEMİR",
    "birthDate": "14.03.1985",
    "roomID": 4,
    "roomName": "104",
    "checkin": 1788863400,
    "checkout": 1788998400,
    "checkout2": null,
    "rezervasyon_id": 282799
}

List in-house guests#

POST/public/json/customer/inhotel

Authentication: ApiKey header

Returns the full list of in-house guests. There are no filter parameters and no request body. A guest appears in the list when the reservation is active, has been checked in and not yet checked out, and the guest is flagged as “in house”. Every guest of the same reservation is a separate record.

The response is not paginated; large hotels may return several hundred records. Cache the list and refresh it at the recommended interval.

Headers

ApiKeystringrequired

Custom API key generated in the HMS admin panel. It is bound to one hotel, which decides whose guests are listed.

HotelCodeinteger

The hotel’s HMS ID. Not used for validation, since the server resolves the hotel from the key; recommended for logging and compatibility.

Response

200 success: 1 and the otelde array. If nobody is in house the array is empty; that is not an error.

successinteger

1 success, 0 failure. A number, not a boolean as in Online Booking.

otelde[]object[]

Guest records. See the Object section above for the fields.

Error responses

401 ApiKey header missing, empty or not defined in HMS (it may have been deleted). Body: {"success": 0}.
405 The request used a method other than POST (for example GET from a browser address bar).

Request

curl -X POST "https://test.hms.gen.tr/public/json/customer/inhotel" \
  -H "ApiKey: $HMS_API_KEY" \
  -H "HotelCode: 1000"

const res = await fetch("https://test.hms.gen.tr/public/json/customer/inhotel", {
  method: "POST",
  headers: {
    "ApiKey": process.env.HMS_API_KEY,
    "HotelCode": "1000"
  }
});
const data = await res.json();

$ch = curl_init('https://test.hms.gen.tr/public/json/customer/inhotel');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'ApiKey: ' . getenv('HMS_API_KEY'),
        'HotelCode: 1000',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Response · 200

{
    "success": 1,
    "otelde": [
        {
            "mikrotikSifreleme": 0,
            "unique": 58211,
            "inHotel": 1,
            "identityNumber": "11111111110",
            "firstName": "AYŞE",
            "lastName": "DEMİR",
            "birthDate": "14.03.1985",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58212,
            "inHotel": 1,
            "identityNumber": "22222222220",
            "firstName": "MEHMET",
            "lastName": "DEMİR",
            "birthDate": "02.11.1982",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58197,
            "inHotel": 1,
            "identityNumber": "U01234567",
            "firstName": "JULIA",
            "lastName": "WAGNER",
            "birthDate": "27.06.1990",
            "roomID": 12,
            "roomName": "205",
            "checkin": 1788782700,
            "checkout": 1789084800,
            "checkout2": null,
            "rezervasyon_id": 282803
        }
    ]
}

Response · 200 (no guests in house)

{
    "success": 1,
    "otelde": []
}

Response · 401 (invalid key)

{
    "success": 0
}

Last updated: 8 September 2026Found a mistake? Let us know