Listings
List every published listing
GET /api/v1/listings
The full set of published properties for the credentials’ organisation, sorted by nickname. It is neither paginated nor a delta. If you mirror it, delete rows the response no longer contains, so an unpublished listing leaves your site.
Response
200 { listings: Listing[] }
Listing fields
| Field | Type | Description |
|---|---|---|
| id | string | Opaque. The same id a reservation’s propertyId carries. |
| slug | string | |
| nickname | string | The operator’s short name for the flat. |
| active | boolean | Always true. Only listed properties are served, and a listed property is in operation. |
| isListed | boolean | Always true. A property taken off the website disappears from this list. |
| propertyType | string | Apartment, House, … as the operator classified it. |
| roomType | string | Entire home/apt, Private room, … |
| address | Address | |
| accommodates | integer | How many people the flat sleeps. |
| rooms | Room[] | |
| bedrooms | integer | Derived from rooms. |
| beds | integer | Derived from rooms. |
| bathrooms | number | Derived from rooms. Fractional for half bathrooms. |
| squareMeter | integer | null | |
| timezone | string | The IANA zone the listing’s dates are local to. |
| pricing | object | |
| currency | "EUR" | |
| rateBasis | enum | Which of monthlyRateCents or nightlyRateCents this listing charges. The other keeps whatever the operator set and is never converted. "monthly""nightly" |
| monthlyRateCents | integer | null | Monthly rent. Integer euro-cents. |
| nightlyRateCents | integer | null | The nightly rate. Integer euro-cents. |
| depositCents | integer | null | Security deposit. Integer euro-cents. |
| utilitiesCents | integer | null | Monthly utilities. Integer euro-cents. |
| furnitureCents | integer | null | Monthly furniture fee. Integer euro-cents. |
| terms | object | |
| minNights | integer | null | The shortest stay the operator accepts. |
| maxNights | integer | null | |
| amenities | string[] | Amenity keys, e.g. wifi, washer, dishwasher. |
| description | Description | |
| translations | map of Description | The same six fields per site language, keyed by language code. Fall back to description for anything missing. |
| images | Image[] | Sorted by sortOrder. The primary photo is not necessarily first. |
| publishedAt | timestamp | When the Publish button froze this content. ISO 8601 |
Notes
descriptionfields are HTML from the editor;titleis plain. Fall back todescriptionfor anything missing fromtranslations.- Money is integer euro-cents; a null price means the operator has not set one.
rateBasissays which ofmonthlyRateCentsornightlyRateCentsthis listing quotes.