Retrieve Room

This endpoint retrieves all rooms associated with a specific Airbnb listing, including room types and bed configurations.

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 containing 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).


listingid numeric (Required)

Listing ID of the property allocated by Airbnb.


Request


Response


Success Response


Success Response - Body Elements

Status string

Indicates the result of the API call. Will be "Success" when room details are retrieved successfully.


Data object

Contains the list of rooms for the specified Airbnb listing.


listing_rooms array of objects

List of rooms returned for the listing:


id string

Airbnb-assigned room ID.


listing_id string

ID of the Airbnb listing to which the room belongs.


room_type string

Type of the room.


is_private boolean

Indicates whether the room is private.


beds array of objects

Bed configuration for the room:


type string

Type of bed.


quantity numeric

Number of beds of this type.


Message string

Describes the result of the operation, confirming that rooms were retrieved successfully.


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?