Unittype data model

Updated:

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNounique identifier for the unit type
created_atstring (date-time)Nowhen the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)Nowhen the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
listing_idstringNopointer to the Property Listing this unit type belongs to
namestringNothe unit type (room type) name
descriptionstringNofree-text description of the unit type
image_urlsstring[]NoURLs of the unit type pictures
unit_countnumberNonumber of bookable units of this type
max_occupancynumberNomaximum number of guests
bedroomsnumberNonumber of bedrooms
bedsnumberNonumber of beds
bathroomsnumberNonumber of bathrooms
min_nightsnumberNominimum length of stay, in nights
max_nightsnumberNomaximum length of stay, in nights
currencystringNoISO 4217 currency code
start_price_amountnumberNothe lowest nightly price
cleaning_fee_amountnumberNothe cleaning fee
extra_person_fee_amountnumberNothe fee per extra guest
amenitiesstring[]Nothe amenity names
metadataPropertyMetadata[]Nocustom field values
metadata[].idstringNothe custom field identifier
metadata[].slugstringNothe custom field key
metadata[].valueobjectNothe custom field value
metadata[].namespacestringNothe scope or origin of the custom field
metadata[].formatenumNothe data type of the value Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNoadditional data about the custom field

TypeScript

TypeScript
export type PropertyUnittype = {
	id?: string; // unique identifier for the unit type
	created_at?: string-time; // when the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // when the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	listing_id?: string; // pointer to the Property Listing this unit type belongs to
	name?: string; // the unit type (room type) name
	description?: string; // free-text description of the unit type
	image_urls?: string[]; // URLs of the unit type pictures
	unit_count?: number; // number of bookable units of this type
	max_occupancy?: number; // maximum number of guests
	bedrooms?: number; // number of bedrooms
	beds?: number; // number of beds
	bathrooms?: number; // number of bathrooms
	min_nights?: number; // minimum length of stay, in nights
	max_nights?: number; // maximum length of stay, in nights
	currency?: string; // ISO 4217 currency code
	start_price_amount?: number; // the lowest nightly price
	cleaning_fee_amount?: number; // the cleaning fee
	extra_person_fee_amount?: number; // the fee per extra guest
	amenities?: string[]; // the amenity names
	metadata?: []; // custom field values
	raw?: any; // raw data from the integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodPropertyUnittype = z.object({
	id: z.string().optional().describe("unique identifier for the unit type"),
	created_at: z.string-time().optional().describe("when the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("when the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	listing_id: z.string().optional().describe("pointer to the Property Listing this unit type belongs to"),
	name: z.string().optional().describe("the unit type (room type) name"),
	description: z.string().optional().describe("free-text description of the unit type"),
	image_urls: z.array().optional().describe("URLs of the unit type pictures"),
	unit_count: z.number().optional().describe("number of bookable units of this type"),
	max_occupancy: z.number().optional().describe("maximum number of guests"),
	bedrooms: z.number().optional().describe("number of bedrooms"),
	beds: z.number().optional().describe("number of beds"),
	bathrooms: z.number().optional().describe("number of bathrooms"),
	min_nights: z.number().optional().describe("minimum length of stay, in nights"),
	max_nights: z.number().optional().describe("maximum length of stay, in nights"),
	currency: z.string().optional().describe("ISO 4217 currency code"),
	start_price_amount: z.number().optional().describe("the lowest nightly price"),
	cleaning_fee_amount: z.number().optional().describe("the cleaning fee"),
	extra_person_fee_amount: z.number().optional().describe("the fee per extra guest"),
	amenities: z.array().optional().describe("the amenity names"),
	metadata: z.array().optional().describe("custom field values"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyUnittype:
	"""unique identifier for the unit type"""
	id: Optional[str]
	"""when the unit type was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""when the unit type was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""pointer to the Property Listing this unit type belongs to"""
	listing_id: Optional[str]
	"""the unit type (room type) name"""
	name: Optional[str]
	"""free-text description of the unit type"""
	description: Optional[str]
	"""URLs of the unit type pictures"""
	image_urls: Optional[List[List[str]]]
	"""number of bookable units of this type"""
	unit_count: Optional[int]
	"""maximum number of guests"""
	max_occupancy: Optional[int]
	"""number of bedrooms"""
	bedrooms: Optional[int]
	"""number of beds"""
	beds: Optional[int]
	"""number of bathrooms"""
	bathrooms: Optional[int]
	"""minimum length of stay, in nights"""
	min_nights: Optional[int]
	"""maximum length of stay, in nights"""
	max_nights: Optional[int]
	"""ISO 4217 currency code"""
	currency: Optional[str]
	"""the lowest nightly price"""
	start_price_amount: Optional[int]
	"""the cleaning fee"""
	cleaning_fee_amount: Optional[int]
	"""the fee per extra guest"""
	extra_person_fee_amount: Optional[int]
	"""the amenity names"""
	amenities: Optional[List[List[str]]]
	"""custom field values"""
	metadata: Optional[PropertyPropertyUnittypeMetadata]
Are we missing anything? Let us know
Was this page helpful?