Skip to navigation

Get Listing Optimizer report for a listing

Returns full Listing Optimizer details for a single Airbnb listing: category letter grades, score breakdowns, improvement tips, and previous-run grades for comparison.

Requires listing_id as a query parameter. Optionally accepts pms_name as a query parameter (defaults to airbnb). If the account has not paid for Optimizer access for this listing, payment_restricted: true is returned and score data is omitted.

Headers

X-API-KeystringRequired
API key for Customer API authentication.

Query parameters

listing_idstringRequired
Listing ID of the Airbnb listing.
pms_namestringOptional

PMS name. Defaults to airbnb.

Response

Listing Optimizer report retrieved successfully.
dataobject
Listing Optimizer report for the listing.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error