Get a listing
Get the full content of one listing.
GET/api/v1/listing/{listingID}
Returns one listing with the same model as List listings.
Path parameters
| Parameter | Type | Description |
|---|---|---|
listingID | UUID | OnSeason listing ID. |
Query parameters
| Parameter | Type | Description |
|---|---|---|
displayCurrency | string | ISO 4217 currency for price fields. |
Example
curl --get \
"https://zepl-staging.calry.app/api/v1/listing/80e0e6d4-48cf-4ca7-8c85-6e8d7e9d969a" \
--header "x-calry-api-key: <API_KEY>" \
--data-urlencode "displayCurrency=EUR"The response is one listing object. List listings shows a full example.
Response
| Field | Description |
|---|---|
id | OnSeason listing ID. Search, availability, quote, and reservation all take this ID. |
providerID | Listing ID in the source PMS. Opaque. |
name, description | Public title and description. |
type | Property category, such as Apartment, House, Hotel, or Villa. |
propertyType | Unit model: SINGLE_UNIT, MULTI_UNIT, or COMPLEX. |
thumbnailURL, pictures | Main image and image set. Each picture has a url and an optional description. |
address, latitude, longitude | Address and map coordinates. |
minimumNights, maximumNights | General stay limits. Availability can return limits per start date. |
maxOccupancy | Maximum number of guests. |
startPrice, currency | Display starting price and its currency. Not a bookable price. |
timeZone | IANA timezone of the property, when the PMS provides one. |
status | ACTIVE or INACTIVE. |
rating | Review count and average, when available. |
bedroomCount, bathroomCount, rooms | Layout. |
checkIn, checkOut | Arrival and departure windows, with start and end times in the property's local time. |
houseRules, listingDetails | Rules and descriptive sections from the PMS. |
amenities | Mapped amenities grouped into categories. |
tags | OnSeason tags on the listing. |
units | Unit records, when the source embeds them. List units always returns them. |
createdAt, updatedAt | When OnSeason created and last changed the content. |
Status codes
| Status | Meaning |
|---|---|
200 | Listing returned. |
400 | The listing ID or currency is invalid. |
401 | The API key is missing or invalid. |
404 | No listing with this ID is enabled for your channel. |