v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Guests

Get guest by id

get/guests-crud/{guestId}

Path parameters

guestIdstring required

Guest id

Query parameters

fieldsstring required

Fields

Response

The guest has been successfully pulled.

_idstring required

firstNamestring required

lastNamestring required

fullNamestring

hometownstring

createdAtstring date-time

addressobject

pictureobject

A link to guest’s picture in different sizes

emailstring

The main contact email of the guest

emailsstring[]

List of additional emails of the guest

phonestring

The main contact phone number

phonesstring[]

List of additional phone numbers of the guest

notesstring

Attention notes about the guest, describing important pieces of information about the guest, to review for all reservations (e.g. “Requires accessibility equipment”)

tagsstring[]

Tags for describing the guest at a glance + show the enum for the field to show the allowed options

goodToKnowNotesstring

“Good to know” notes about the guest. Notes to help capture facts about the guest that will help the team to personalize the guest’s stays (e.g. “Big football fan”)

preferredLanguagestring

birthdaystring date-time

genderstring

maritalStatusstring

dietaryPreferencesstring[]

You can pick one of the predefined options, or create a new one for your account

allergiesstring[]

You can pick one of the predefined options, or create a new one for your account

interestsstring[]

pronounsstring

kidsnumber

passportNumberstring

identityNumberstring

nationalitystring

contactTypestring

airbnb2object

rentalsUnitedobject

bookingComobject

homeAwayobject

tripAdvisorobject

policyobject

returningGuestboolean required

Example response

{
  "_id": "5e17287629e111001f7d3f4d",
  "firstName": "Rick",
  "lastName": "Sanchez",
  "fullName": "Rick Sanchez",
  "hometown": "New York",
  "createdAt": "2022-08-12T16:00:00.000+03:00",
  "address": {
    "street": "1000 5th Ave",
    "city": "New York",
    "country": "United States",
    "countryCode": "US",
    "zipCode": "10028",
    "state": "New York"
  },
  "picture": {
    "thumbnail": "//guestybookings.s3.amazonaws.com/guests/thumbnail_e2cb8a96-45a9-45cd-b28e-57e1ca1fc988.jpg",
    "large": "//guestybookings.s3.amazonaws.com/guests/large_e2cb8a96-45a9-45cd-b28e-57e1ca1fc988.jpg",
    "regular": "//guestybookings.s3.amazonaws.com/guests/regular_e2cb8a96-45a9-45cd-b28e-57e1ca1fc988.jpg"
  },
  "email": "email@email.com",
  "emails": [
    "email@email.com",
    "email2@email.com"
  ],
  "phone": "972234567454",
  "phones": [
    "972234567454",
    "972234567890"
  ],
  "notes": "This guest is rich",
  "tags": [
    "blocklisted",
    "VIP"
  ],
  "goodToKnowNotes": "This guest is alleric to peanuts",
  "birthday": "2017-08-12T16:00:00.000+03:00",
  "gender": "2017-08-12T16:00:00.000+03:00",
  "maritalStatus": "single",
  "dietaryPreferences": [
    "vegan",
    "veggies"
  ],
  "interests": [
    "sports"
  ],
  "pronouns": "he/him/his",
  "otaLinks": [
    {
      "type": "airbnb",
      "url": "https://www.airbnb.com"
    }
  ],
  "kids": 3,
  "passportNumber": "23424353",
  "identityNumber": "324325121",
  "nationality": "il",
  "contactType": "guest",
  "airbnb2": {
    "index": "index",
    "id": 4246064595217,
    "url": "https://www.airbnb.com",
    "firstName": "Rick"
  },
  "rentalsUnited": {
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "failedPaymentMethod": "failed payment method"
  },
  "bookingCom": {
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "url": "https://www.booking.com"
  },
  "homeAway": {
    "title": "title",
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "url": "https://www.homeaway.com"
  },
  "tripAdvisor": {
    "title": "title",
    "firstName": "Rick",
    "lastName": "Sanchez",
    "fullName": "Rick Sanchez",
    "proxyEmail": "proxyemail@email.com",
    "url": "https://www.tripadvisor.com"
  },
  "policy": {
    "marketing": {
      "isAccepted": false,
      "dateOfAcceptance": null
    },
    "privacyObject": {
      "isAccepted": false,
      "dateOfAcceptance": null,
      "versionNumber": "ffewfewgw"
    }
  }
}