Listing data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | unique identifier for the listing |
created_at | string (date-time) | No | when the listing was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | when the listing was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | the public listing name |
internal_name | string | No | the internal (host-facing) listing name |
description | string | No | free-text description of the listing |
type | enum | No | the normalized property type Values: APARTMENT, HOUSE, CONDO, STUDIO, VILLA, CABIN, ROOM, HOTEL, BED_AND_BREAKFAST, OTHER |
is_active | boolean | No | whether the listing is active |
image_urls | string[] | No | URLs of the listing pictures |
address | object | No | postal address of the listing |
address.address1 | string | No | first line of the street address |
address.address2 | string | No | second line of the street address |
address.city | string | No | city or locality |
address.region | string | No | state, province or regional area |
address.region_code | string | No | state, province or regional area code |
address.postal_code | string | No | postal or ZIP code |
address.country | string | No | country name |
address.country_code | string | No | ISO 3166-1 alpha-2 country code |
latitude | number | No | latitude of the listing |
longitude | number | No | longitude of the listing |
timezone | string | No | IANA time zone of the listing |
currency | string | No | ISO 4217 currency code |
start_price_amount | number | No | the lowest nightly price |
cleaning_fee_amount | number | No | the cleaning fee |
max_occupancy | number | No | maximum number of guests |
bedrooms | number | No | number of bedrooms |
beds | number | No | number of beds |
bathrooms | number | No | number of bathrooms |
min_nights | number | No | minimum length of stay, in nights |
max_nights | number | No | maximum length of stay, in nights |
check_in_start_time | string | No | earliest check-in time (HH:mm, local time) |
check_in_end_time | string | No | latest check-in time (HH:mm, local time) |
check_out_time | string | No | check-out time (HH:mm, local time) |
amenities | string[] | No | the amenity names |
house_rules | string | No | the house rules |
cancellation_policy | string | No | the cancellation policy |
rating | number | No | the average guest rating |
review_count | number | No | the number of guest reviews |
channels | PropertyChannel[] | No | distribution channels this listing is published on |
channels[].name | string | No | the distribution channel name, eg. Airbnb or Booking.com |
channels[].web_url | string | No | the listing URL on that channel |
unittype_ids | string[] | No | Property Unittypes (room types) of this listing |
owner_user_ids | string[] | No | HR Employees who own this listing |
web_url | string | No | the listing URL |
metadata | PropertyMetadata[] | No | custom field values |
metadata[].id | string | No | the custom field identifier |
metadata[].slug | string | No | the custom field key |
metadata[].value | object | No | the custom field value |
metadata[].namespace | string | No | the scope or origin of the custom field |
metadata[].format | enum | No | the data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | additional data about the custom field |
Are we missing anything? Let us know
Was this page helpful?