API Explorer

Get all the listings included in the booking engine

get
https://booking.guesty.com/api/listings

This call returns the list of listings connected to the requester Booking Engine API instance in Guesty and filtered by given parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

The minimum value of listing occupancy

integer
Defaults to 0

The minimum amount of listing bedrooms

integer
Defaults to 0

The minimum amount of listing bathrooms

string
enum

The listing property type.

string
enum

The listing type.

Allowed:
string
enum

The listing room type.

Allowed:
number
≥ 0

Minimum value of listing price. If it provided, the response will have listings which price is great or equal. Should be passed with currency query parameter

number
≥ 1

Maximum value of listing price. If it provided, the response will have listings which price is less or equal. Should be passed with currency query parameter

string
enum

Listing price currency. Should be provided with minPrice query parameter

string
enum

Listing amenities separated by coma which should have listings. Possible values are listed in the enum.

string
enum

Listing amenities separated by coma which should not have listings. Possible values are listed in the enum.

number
-180 to 180

Minimum longitude

number
-180 to 180

Maximum longitude

number
-90 to 90

Minimum latitude

number
-90 to 90

Maximum latitude

string

City name from the listings address

string

Country name from the listings address

string

State name from the listings address

string

neighborhood from the listings address

string

The list of the listing fields to return separated by spaces. The fields should be taken from Listing object definition. To include bed arrangements to a response, please add bedArrangements to the fields in query params.

string

checkin day in format YYYY-MM-DD

string

checkout day in format YYYY-MM-DD

integer
1 to 100
Defaults to 20

Limit the number of results within a subset. Default value is 20, max value is 100

tags
array of strings

Limit results to listings with specific tag, can be used multiple times for and function

tags
integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

integer
≥ 1

one of bed types

boolean

Limit results to listings' unit type house rules

boolean

Limit results to listings' unit type house rules

boolean

Limit results to listings' unit type house rules

boolean

Limit results to listings' unit type house rules

boolean

Limit results to listings' unit type house rules

string

Provide cursor received from the response to iterate over pages

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?