Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Listings

Create a listing

post/listings

Request body

titlestring required
originstring

Marks the origin platform that the listing was migrated from

originIdstring

Marks the origin platform listing ID

accommodatesnumber
bathroomsnumber

Starting March 4th 2025, the bathroom field will be deprecated. Please use the Spaces endpoints to add and manage bathroom details moving forward.

minimumAgenumber
timezonestring
propertyType'Aparthotel' | 'Apartment' | 'Barn' | 'Bed & Breakfast' | 'Boat' | 'Boutique hotel' | 'Bungalow' | 'Cabin' | 'Camper/RV' | 'Casa particular (Cuba)' | 'Castle' | 'Cave' | 'Chalet' | 'Condominium' | 'Cottage' | 'Cycladic house (Greece)' | 'Dammuso' | 'Dome house' | 'Dorm' | 'Earth house' | 'Farm stay' | 'Guest suite' | 'Guesthouse' | 'Heritage hotel (India)' | 'Holiday home' | 'Hostel' | 'Hotel' | 'House' | 'Houseboat' | 'Hut' | 'Igloo' | 'In-law' | 'Inn' | 'Island' | 'Lighthouse' | 'Loft' | 'Minsu' | 'Nature lodge' | 'Other' | 'Parking Space' | 'Pension (South Korea)' | 'Plane' | 'Resort' | 'Rv' | 'Ryokan (Japan)' | 'Serviced apartment' | 'Shepherds hut' | 'Studio' | 'Tent' | 'Timeshare' | 'Tiny house' | 'Tipi' | 'Townhouse' | 'Train' | 'Treehouse' | 'Trullo (Italy)' | 'Vacation home' | 'Villa' | 'Windmill' | 'Yurt'

Describes the kind of property where your guest will stay (e.g., Apartment, House, Villa, Boat, Tent, etc.). Corresponds to the Property type in the UI

roomType'Entire home/apt' | 'Private room' | 'Shared room'

Indicates the level of privacy your guest will have during their stay (e.g., Entire home/apt, Private room, or Shared room). Corresponds to the Listing type in the UI

otaRoomType'Apartment' | 'Bed in dormitory' | 'Bungalow' | 'Chalet' | 'Dormitory room' | 'Double' | 'Family' | 'Holiday home' | 'Mobile home' | 'Quadruple' | 'Single' | 'Studio' | 'Suite' | 'Tent' | 'Triple' | 'Twin' | 'Villa'

A Booking.com-specific field that defines either the property type or room capacity, depending on whether the stay is in a full unit or a single-room setup (e.g., Suite, Double, Villa, Bed in dormitory). Corresponds to the Room type in the UI

defaultCheckInTimestring
defaultCheckOutTimestring
type'SINGLE' | 'MTL' required

Listing type

tagsstring[]
nicknamestring required

Listing nickname

amenitiesstring[]
manageSubunitPicturesboolean
isListedboolean
numberOfChildrenToCreatenumber
isTestboolean

Marks the listing as a test property. Test property titles must include the 'Test_' prefix. Only SINGLE-type listings can be selected.

Example request

{
  "address": {
    "full": "Kaplan St 2, Ramat Gan, Israel",
    "lng": 34.8202173,
    "lat": 32.0695525
  },
  "title": "Example listing title",
  "origin": "company_name",
  "originId": "67890234",
  "pictures": [
    {
      "thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "height": 756,
      "original": "https://res.cloudinary.com/guesty/image/upload/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "size": 39516,
      "width": 756
    }
  ],
  "pms": {
    "cleaningStatus": {
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  },
  "mtl": {
    "aas": "bc",
    "aao": "f"
  }
}

Response

Listing

_idstring

String (ObjectId)

accountIdstring

String (ObjectId)

createdAtstring
isVirtualboolean
nicknamestring
tagsstring[]
isListedboolean
titlestring
propertyTypestring
roomTypestring
bedTypestring
accommodatesnumber
bedroomsnumber
areaSquareFeetnumber
timezonestring
defaultCheckInTimestring
defaultCheckOutTimestring
amenitiesstring[]
amenitiesNotIncludedstring[]
netIncomeFormulastring
commissionFormulastring
commissionTaxPrecentagestring
activeboolean
customFieldsobject
calendarRulesobject
publicDescriptionobject
privateDescriptionobject
markupsobject
isTestboolean

Marks the listing as a test property. Test property titles must include the 'Test_' prefix. Only SINGLE-type listings can be selected.

Example response

{
  "_id": "59ac245d27cb310f0017afe3",
  "accountId": "59ac245d27cb310f0017afe3",
  "createdAt": "2017-09-03T15:48:45.070Z",
  "integrations": [
    {
      "_id": "5958c7e5884e961000817799",
      "airbnb2": {
        "ignored": {
          "reservations": [],
          "listings": []
        },
        "emailsFromSupport": []
      },
      "nickname": "naama",
      "userId": "563e0b6a08a2710e00057b85",
      "accountId": "563e0b6a08a2710e00057b82"
    }
  ],
  "address": {
    "full": "Kaplan St 2, Ramat Gan, Israel",
    "lng": 34.8202173,
    "lat": 32.0695525
  },
  "publishedAddress": {
    "full": "Kaplan St 2, Ramat Gan, Israel",
    "lng": 34.8202173,
    "lat": 32.0695525
  },
  "cleaningStatus": {
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "picture": {
    "thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
    "height": 756,
    "original": "https://res.cloudinary.com/guesty/image/upload/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
    "size": 39516,
    "width": 756
  },
  "pictures": [
    {
      "thumbnail": "https://res.cloudinary.com/guesty/image/upload/c_fit,h_200/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "height": 756,
      "original": "https://res.cloudinary.com/guesty/image/upload/v1659982852/staging6/5213a2d206112710005d96ff/gglflnes8vodgkmtm08c.jpg",
      "size": 39516,
      "width": 756
    }
  ],
  "pms": {
    "cleaningStatus": {
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  }
}