Retrieve All Listings

This endpoint retrieves all Airbnb listings for a given hotel, including mapped room and rate IDs if available, along with listing names and identifiers.

Endpoint

POST


Header
Type
Required
Description

app-id

string

Yes

Your application ID. Required for authentication.

Authorization

string

Yes

Your API key. for authorization. Required for authentication.

Content-Type

string

Yes

Must be set to application/json.


Attributes

hotelid alphanumeric (Required)

Specifies the required node hotelid contains the IT provider's hotel id for which the provider wishes to add mapping information


channelhotelid alphanumeric (Required)

Specifies the unique hotel ID used in the external distribution channel or PMS (Property Management System).

circle-info

NOTE:

If listing is mapped in our system, then we will provide mapped rate id and room id with listing in response.


Request


Response


Success Response


Success Response - Body Elements


Status string

Indicates whether the API request was successful. Will always be "Success" in a successful response.


Data array

A list of listing objects retrieved for the given hotelid and channelhotelid.


listingid string

A unique identifier for the listing within the Airbnb channel.


listing_name string

The name of the listing as it appears in Airbnb.


rateid string

The mapped rate ID. Returned only if the listing is already mapped in the system.


roomid string

The mapped room ID. Returned only if the listing is already mapped in the system.


Message string

A descriptive message indicating the result of the request.


Error Response


Error Response - Body Elements

Status string

Indicates the result of the API call.

circle-info

Will be always "Fail" in case of an error response.


Errors object

The response error, the root element.


Code string

Specific error code that helps identify the type of error.

circle-info

For example: "400" indicates a bad request.


ShortText string

A short description of the error.


Message string

The message in the response.

Last updated

Was this helpful?