Guest data model

Updated:

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

Data Model
FieldTypeRequiredDescription
idstringNounique identifier for the guest
created_atstring (date-time)Nowhen the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)Nowhen the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNothe guest full name
first_namestringNothe guest first name
last_namestringNothe guest last name
emailsPropertyEmail[]Noemail addresses of the guest
emails[].emailstringYesthe email address
emails[].typeenumNothe kind of email address Values: WORK, HOME, OTHER
telephonesPropertyTelephone[]Notelephone numbers of the guest
telephones[].telephonestringYesthe telephone number
telephones[].typeenumNothe kind of telephone number Values: WORK, HOME, MOBILE, FAX, OTHER
addressobjectNopostal address of the guest
address.address1stringNofirst line of the street address
address.address2stringNosecond line of the street address
address.citystringNocity or locality
address.regionstringNostate, province or regional area
address.region_codestringNostate, province or regional area code
address.postal_codestringNopostal or ZIP code
address.countrystringNocountry name
address.country_codestringNoISO 3166-1 alpha-2 country code
languagestringNothe guest preferred language (ISO 639-1)
nationalitystringNothe guest nationality
company_namestringNothe guest company name
image_urlstringNoURL of the guest picture
notesstringNofree-text notes about the guest
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 PropertyGuest = {
	id?: string; // unique identifier for the guest
	created_at?: string-time; // when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // the guest full name
	first_name?: string; // the guest first name
	last_name?: string; // the guest last name
	emails?: []; // email addresses of the guest
	telephones?: []; // telephone numbers of the guest
	address?: {
		address1?: string; // first line of the street address 
		address2?: string; // second line of the street address 
		city?: string; // city or locality 
		region?: string; // state, province or regional area 
		region_code?: string; // state, province or regional area code 
		postal_code?: string; // postal or ZIP code 
		country?: string; // country name 
		country_code?: string; // ISO 3166-1 alpha-2 country code 
	}; // postal address of the guest
	language?: string; // the guest preferred language (ISO 639-1)
	nationality?: string; // the guest nationality
	company_name?: string; // the guest company name
	image_url?: string; // URL of the guest picture
	notes?: string; // free-text notes about the guest
	metadata?: []; // custom field values
	raw?: any; // raw data from the integration
}

Zod

Zod
import { z } from 'zod';

export const ZodPropertyGuest = z.object({
	id: z.string().optional().describe("unique identifier for the guest"),
	created_at: z.string-time().optional().describe("when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("the guest full name"),
	first_name: z.string().optional().describe("the guest first name"),
	last_name: z.string().optional().describe("the guest last name"),
	emails: z.array().optional().describe("email addresses of the guest"),
	telephones: z.array().optional().describe("telephone numbers of the guest"),
	address: z.object({
			address1: z.string().optional().describe("first line of the street address"),
			address2: z.string().optional().describe("second line of the street address"),
			city: z.string().optional().describe("city or locality"),
			region: z.string().optional().describe("state, province or regional area"),
			region_code: z.string().optional().describe("state, province or regional area code"),
			postal_code: z.string().optional().describe("postal or ZIP code"),
			country: z.string().optional().describe("country name"),
			country_code: z.string().optional().describe("ISO 3166-1 alpha-2 country code")
}).optional().describe("postal address of the guest"),
	language: z.string().optional().describe("the guest preferred language (ISO 639-1)"),
	nationality: z.string().optional().describe("the guest nationality"),
	company_name: z.string().optional().describe("the guest company name"),
	image_url: z.string().optional().describe("URL of the guest picture"),
	notes: z.string().optional().describe("free-text notes about the guest"),
	metadata: z.array().optional().describe("custom field values"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertyPropertyGuestAddress:
	"""first line of the street address"""
	address1: Optional[str]
	"""second line of the street address"""
	address2: Optional[str]
	"""city or locality"""
	city: Optional[str]
	"""state, province or regional area"""
	region: Optional[str]
	"""state, province or regional area code"""
	region_code: Optional[str]
	"""postal or ZIP code"""
	postal_code: Optional[str]
	"""country name"""
	country: Optional[str]
	"""ISO 3166-1 alpha-2 country code"""
	country_code: Optional[str]

@dataclasses.dataclass
class PropertyGuest:
	"""unique identifier for the guest"""
	id: Optional[str]
	"""when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""the guest full name"""
	name: Optional[str]
	"""the guest first name"""
	first_name: Optional[str]
	"""the guest last name"""
	last_name: Optional[str]
	"""email addresses of the guest"""
	emails: Optional[PropertyPropertyGuestEmails]
	"""telephone numbers of the guest"""
	telephones: Optional[PropertyPropertyGuestTelephones]
	"""postal address of the guest"""
	address: Optional[PropertyPropertyGuestAddress]
	"""the guest preferred language (ISO 639-1)"""
	language: Optional[str]
	"""the guest nationality"""
	nationality: Optional[str]
	"""the guest company name"""
	company_name: Optional[str]
	"""URL of the guest picture"""
	image_url: Optional[str]
	"""free-text notes about the guest"""
	notes: Optional[str]
	"""custom field values"""
	metadata: Optional[PropertyPropertyGuestMetadata]
Are we missing anything? Let us know
Was this page helpful?