Fields/Columns for Guest Reports
Describes the guest columns or fields that can be returned in reports.
Terminology
The Get guest by id document uses the term fields
, whereas the Get guests list document uses columns
. Both refer to the same parameters that make up the guest object. However, be sure to write the parameter name as described in each document.
List of Columns
This table provides a comprehensive list of Guest object parameters that are retrievable via the API. It also includes enumerations where applicable.
Column | Type | Description | Included in the single guest request? | Included in the retrieve all guests request? |
---|---|---|---|---|
id | string | The object ID and primary identifier. | yes | yes |
dateCreated | string | The date the guest was created on the account in ISO 8601 format. | no | no |
firstName | string | The guest's first name. | yes | yes |
lastName | string | The guest's surname. | yes | yes |
fullName | string | The guest's first and last name. | yes | yes |
tags | [string] | Array for any custom tags applied to the guest. | yes | yes |
notes | string | An important note for your team. | yes | yes |
goodToKnowNotes | string | A note with non-essential information. | yes | yes |
guestEmail | string | The guest's primary email. | no | yes |
guestOtherEmails | [string] | The guest's secondary emails. | no | yes |
guestPhone | string | The guest's primary phone number. | no | yes |
guestOtherPhones | [string] | An array of the guest's secondary phone numbers. | no | yes |
guestHometown | string | The town or city where the guest lives. | no | yes |
allergies | [string] | An array of common allergies. It can include any of these values: milk , cat , wheat , egg , peanut , feather , detergent , soy , treenut , shellfish , fish , sesame , honey , corn , meat , gelatin , seed , spice , fruit , vegetable . | yes | yes |
interests | [string] | An array of interests. It can contain any of the following: music , nature , sightseeing , hiking , tennis , concerts , eatingOut , art , fitness , diving , surfing , ski | yes | yes |
dietaryPreferences | [string] | An array of dietary needs. It can contain any of the following: glutenFree , kosher , vegan , lactoseFree , vegetarian , diabetic , halal | yes | yes |
preferredLanguage | string | Set the guest's preferred language using the language's two letter ISO 639-1 code | yes | yes |
birthday | string | The guest's date of birth in ISO 8601 format. | yes | yes |
gender | string | It can be any of these options: female , male , or other . | yes | yes |
pronouns | string | It can be any of one of these options: she/her/hers , he/him/his , they/them/their , or xe/xem/xyr . | yes | yes |
maritalStatus | string | Choose from any of the following: single , married , widowed , separated , divorced . | yes | yes |
kids | number | The number of children the guest has. | yes | yes |
passportNumber | string | The guest's passport number. | yes | yes |
identityNumber | string | The guest's national ID number. | yes | yes |
nationality | string | Assign the country using its ISO 3166 Alpha-2 country code. | yes | yes |
Reservation Metadata | [object] | Contains information on a guest's stays. It is an array of objects. | no | yes |
numberOfReservations | number | The total number of reservations and inquiries the guest has requested over time. | no | no |
numberOfConfirmedReservations | number | The total number of confirmed reservations the guest has booked over time. | no | no |
lastCheckOut | string | The check-out date of the most recent stay of the guest in ISO 8601 format. | no | no |
returningGuest | boolean | Shows true if the guest has previous stays recorded and false if it's their first booking. | yes | yes |
averageReview | number | Aggregated review metric from Airbnb and Booking.com bookings. | no | no |
lastCommunicationDate | string | The date of the last message between the PM/Host and guest in ISO 8601 format. | no | yes |
address | object | The guest's full street address. | yes | yes |
marketingConsent | boolean | true when the guest agrees to receive marketing materials from the PM/Host or false when they choose not to. | no | yes |
marketingConsentDate | string | The date the guest consented to receive marketing material in ISO 8601 format. | no | yes |
picture | object | A link to the guest's picture in different sizes. | no | no |
Updated about 1 month ago