Guest

The Guest entity is used within the Reservation entity to specify information about the guests related to the reservation.

Fields

Field	Type	Description
id	string	The unique identifier for the guest resource.
createdAt	string	The time at which the guest resource was created.
name_prefix	string	Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.).
name_first	string	Given name, first name or names.
name_last	string	Family name, last name. This is the only required field for name. For instance, if a guest is only a single named guest (i.e. Madonna) it would go into this field.
sexCode	number	There is a special case for sexCode, as per the ISO/IEC 5218 standard. If the vacation rental software doesn't provide the information the value returned will not be null, and instead will be 0.
emails	Array<string>	Email addresses, the vacation rental software has record of, for the guest in question.
mobile_numbers	Array<number>	Phone numbers, the vacation rental software has record of, for the guest in question.
preferred_language	string	ISO 639-1 - The language that the guest prefers to communicate in. The language may not be supported by the hotel.
nationality	string	Nationality, the vacation rental software has record of, for the guest in question in ISO 3166-1 alpha-3 format.
company_names	Array<string>	Unlike the company name in the Reservation, this is a string field provided by the guest. This field is not typically required.
notes	string	A free text field for notes that the vacation rental software holds on the guest in question.
documents	Array<{}>	Documents, the vacation rental software has record of, for the guest in question, for example, Passports, Driving Licences.
pictures	Array<{}>	Pictures, the vacation rental software has record of, for the guest in question.
addresses	Array<Addresses>	Addresses, the vacation rental software has record of, for the guest in question.
preferences	Array<string>	A set of codes that represent desired options for a given guest. These are preferences that the guest adds or requests to be added to their profile to be utilized across stays.

Address Sub-fields

Field	Type	Description
line1	string	The first line of the address.
line2	string	The second line of the address (if any).
postal_code	string	The postal or ZIP code for the address.
city	string	The city where the address is located.
street	string	The street where the address is located.
state	string	The state or province of the address.
country	string	The country where the address is located.

---

Supported fields in each source system:

Field	Hostaway	Smoobu	Lodgify	Hostfully	Beds24	Hospitable	Lodgix	Zeevou	OwnerRez	BookingSync
id	✅	✅	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
createdAt	-	-	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
name_prefix	-	-	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
name_first	✅	✅	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
name_last	✅	✅	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
sexCode	-	-	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
emails	✅	✅	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
mobile_numbers	-	✅	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
preferred_language	✅	✅	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
nationality	✅	✅	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
company_names	-	✅	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
notes	✅	✅	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
documents	-	-	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
pictures	✅	-	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜
addresses	✅	✅	✅	🔜	🔜	🔜	🔜	🔜	🔜	🔜
preferences	-	-	-	🔜	🔜	🔜	🔜	🔜	🔜	🔜

✅ Supported and mapped
🔶 Partially mapped, not exact match
🔜 Launching soon
— Not supported in source system

---

Supported Methods

1. Get Guest
2. Get All Guests

---

Sample Response

{
    "id": "G12345",
    "created_at": "2023-10-25T12:34:56Z",
    "name_prefix": "Mr.",
    "name_first": "John",
    "name_last": "Doe",
    "sexCode": 1,
    "emails": ["john.doe@example.com"],
    "mobile_numbers": [1234567890],
    "preferred_language": "en",
    "nationality": "USA",
    "company_names": ["Doe Industries"],
    "notes": "Regular guest, prefers quiet rooms.",
    "documents": [
        {
            "type": "Passport",
            "number": "X1234567"
        },
        {
            "type": "Driving Licence",
            "number": "Y7654321"
        }
    ],
    "pictures": [
        {
            "url": "http://example.com/john_doe_pic1.jpg"
        },
        {
            "url": "http://example.com/john_doe_pic2.jpg"
        }
    ],
    "addresses": [
        {
            "line1": "123 Elm St.",
            "line2": "Apt 4B",
            "postal_code": "12345",
            "city": "Sample City",
            "state": "NY",
            "country": "USA"
        }
    ],
    "preferences": ["K1", "NS", "HF"]
}