This endpoint is used to get the in house guest list of the hotel.
Request
GET https://app.hotelrunner.com/api/v1/apps/hotspot/guests
Query Parameters
| Key | Description |
|---|---|
| TOKEN | Token generated for this integration on integration setup page |
| HR ID | Hotel ID provided on integration setup page |
Example: GET https://app.hotelrunner.com/api/v1/apps/hotspot/guests?token=12345&hr_id=67890
The above request returns a JSON output like the following:
{
"status": "success",
"data": [
{
"identify": "11111111111",
"firstname": "Alican",
"lastname": "Soydan",
"gender": "male",
"room": "10700",
"country": "TR",
"nationality": "TR",
"email": "integrations@hotelrunner.com",
"phone_number": "+905333333333",
"birth_date": "1902-01-01",
"checkin_date": "2023-11-12",
"checkout_date": "2024-01-31"
},
{
"identify": "11111111112",
"firstname": "Melahat",
"lastname": "Soydan",
"gender": "male",
"room": "10700",
"country": "TR",
"nationality": "TR",
"email": "integrations@hotelrunner.com",
"phone_number": "+905333333333",
"birth_date": "1902-01-01",
"checkin_date": "2023-11-12",
"checkout_date": "2024-01-31"
},
],
"total_count": 2
}
Output
| Name | Description |
|---|---|
| identify | Identifier of the guest ID |
| firstname | First name of the guest |
| lastname | Last name of the guest |
| gender | Gender of the guest - can be null |
| room | Room number of the guest where they stay |
| country | Country of the guest |
| nationality | Nationality of the guest |
| Email of the guest | |
| birth_date | Birth date of the guest |
| checkin_date | Check-in date of the guest |
| checkout_date | Check-out date of the guest |