Unittype 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 unit type |
created_at | string (date-time) | No | when the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | when the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
listing_id | string | No | pointer to the Property Listing this unit type belongs to |
name | string | No | the unit type (room type) name |
description | string | No | free-text description of the unit type |
image_urls | string[] | No | URLs of the unit type pictures |
unit_count | number | No | number of bookable units of this type |
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 |
currency | string | No | ISO 4217 currency code |
start_price_amount | number | No | the lowest nightly price |
cleaning_fee_amount | number | No | the cleaning fee |
extra_person_fee_amount | number | No | the fee per extra guest |
amenities | string[] | No | the amenity names |
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?