Retrieve Detailed Description

This endpoint retrieves the full set of descriptive information for a specific Airbnb listing, including summary, space details, rules, notes, and other description fields.

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


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 descriptions are retrieved successfully.


Data object

Contains the listing description details.


listing_descriptions array of objects

List of description records for the listing:


transit string

Transportation or transit-related details.


summary string

Short summary of the listing.


notes string

Additional notes provided by the host.


name string

Name of the listing.


locale string

Language code of the description.


interaction string

Host–guest interaction details.


house_rules string

House rules for the listing.


listing_id string

ID of the listing.


neighborhood_overview string

Overview of the neighborhood.


access string

Guest access details.


space string

Description of the space.


description string

Primary description of the listing.


Message string

Message confirming that the listing description was 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?