Retrieve Photo
This endpoint retrieves all photos associated with a specific Airbnb listing, including listing, room, and amenity images along with their metadata.
Endpoint
POST
Header
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" if photos are retrieved successfully.
Data object
Contains the photo details of the listing.
listing_photos array of objects
Each object represents a photo and contains:
id string
Airbnb-assigned photo ID.
caption string
Caption of the photo.
sort_order numeric
Sort order of the photo.
thumbnail_url string
URL of the photo in small thumbnail size.
extra_medium_url string
URL of the photo in medium size.
small_url string
URL of the photo in small size.
category string
Category of the photo (LISTING, ROOM, LISTING_AMENITY, ROOM_AMENITY).
listing_id string
Airbnb listing ID associated with the photo.
room_id string (Optional)
ID of the Airbnb room if the photo is room-specific.
facility_id numeric (Optional)
ID of the facility if the photo is amenity-specific.
metadata object (Optional)
Contains additional info such as accessibility status.
Message string
Response message indicating the overall result of the photo retrieval operation.
Error Response
Error Response - Body Elements
Status string
Indicates the result of the API call.
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.
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?