Create a listing

post

https://open-api.guesty.com/v1/listings

Create a listing on your account. The address you supply is geocoded to resolve its coordinates. A new listing is unlisted until you publish it, and check-in and check-out default to 15:00 and 11:00 when defaultCheckInTime and defaultCheckOutTime are omitted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Onboard a listing to Guesty.

address

object

required

Listing address. Any full address will do (the data will be parsed into the rest of the address fields). Use the Address endpoints to manage address details.

title

string

required

Listing title. Must be 3-50 characters long

origin

string

Marks the origin platform that the listing was migrated from

originId

string

Marks the origin platform listing ID

accommodates

number

Defaults to 2

Maximum number of guests the listing accommodates. Defaults to 2.

bathrooms

float

deprecated

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

minimumAge

number

Minimum age required for the primary guest of a reservation at this listing.

prices

object

required

Listing pricing configuration, such as base price, currency, and extra guest fees.

terms

object

required

Booking terms for the listing, such as minimum and maximum nights.

timezone

string

Defaults to Asia/Jerusalem

IANA timezone identifier for the listing.

propertyType

string

enum

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

string

enum

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

Allowed:

otaRoomType

string

enum

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

pictures

array of objects

required

Array of listing pictures.

pictures*

defaultCheckInTime

string

^([01]\d|2[0-3]):([0-5]\d)$

Defaults to 15:00

Default check-in time for reservations at this listing, in HH:mm format.

defaultCheckOutTime

string

^([01]\d|2[0-3]):([0-5]\d)$

Defaults to 10:00

Default check-out time for reservations at this listing, in HH:mm format.

type

string

enum

required

Listing type

Allowed:

tags

pms

object

Property management system (PMS) configuration for the listing.

owners

array

Defaults to []

Owners assigned to the listing

owners

nickname

string

required

Listing nickname. Must be 1-20 characters long.

amenities

array of strings

Array of amenity names available at the listing. Manage amenities via the Amenities endpoints.

amenities

mtl

object

The multi-unit settings for onboarding a multi-unit property.

manageSubunitPictures

boolean

Whether pictures are managed at the sub-unit level for multi-unit (MTL) listings. Set as true for the sub-units to inherit the multi-unit's pictures, or false to manage the pictures on the unit level.

isListed

boolean

Whether the listing is published and visible.

numberOfChildrenToCreate

number

Number of child/sub-unit listings to create when creating a multi-unit (MTL) listing.

isTest

boolean

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

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Listing