Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Channels

Query Listings

Query the listings (third-party properties) synced from the operator's connected channel accounts. A listing is a property as it exists on a specific channel, identified by listing_id (the channel-side property id). Filter by channel_account_id, listing_id and/or channel_type to scope results.

get/listings

Query parameters

channel_account_idinteger

Internal id of a channel account (from GET /channel_accounts). Limits results to listings under this account.

listing_idstring

Channel-side listing id (matches the listing_id exposed by other endpoints).

channel_type'airbnb' | 'booking.com' | 'agoda' | 'expedia' | 'vrbo' | 'trip.com' | 'booking_site' | 'tujia_intl' | 'hostex_direct' | 'tujia' | 'xiaozhu' | 'meituan_bnb' | 'meituan_hotel' | 'muniao' | 'fliggy' | 'zhukeyun' | 'tiktok' | 'xiaohongshu' | 'ctrip' | 'houfy'

The type of the channel. See Supported Channels for more information.

Filter by channel type.

offsetinteger

The starting point from which to begin returning results. Default: 0.

limitinteger

The maximum number of results to return. The maximum value is 100. Default: 20.

Response

A list of listings synced from connected channel accounts.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}