API ReferenceCustomer APIListings

Get a minimal list of listings

Returns a minimal, lightweight list of every listing in the account — just the core identifying fields (`listing_id`, `pms_name`, `listing_name`, `property_name`, `parent_key`, `group_id`) plus each listing's IDs on the booking channels/OTAs it is published on (`channel_listing_details` — Airbnb, Vrbo, Booking.com, Expedia, etc.). Unlike `GET /v1/listings`, this call returns no performance metrics or pricing, so it stays fast for large accounts that just need a quick listing directory or to map their PriceLabs listings to the corresponding channel listing IDs.

Headers

X-API-KeystringRequired

Query parameters

search_querystringOptional
Partial match on listing name, ID fragment, city, tags, or groups.
listing_namestringOptional

Partial match on listing name only (not for numeric IDs or UUIDs).

listingsstringOptional

Comma-separated exact listing IDs or UUIDs to return.

pmsstringOptional

Comma-separated PMS names to filter by (e.g. airbnb,hostaway).

citiesstringOptional

Comma-separated city names to filter by.

groupsstringOptional

Comma-separated group names to filter by.

subgroupsstringOptional

Comma-separated sub-group names to filter by.

Response

Success
listingslist of objectsOptional
total_listingsintegerOptional
Total number of listings returned

Errors

403
Forbidden Error