--- title: "Guest data model" url: "https://docs.unified.to/property/guest/model" description: "The Guest data model object in Unified's Guest API: 15 fields, including created_at, updated_at and name, with types and enum values." date: "2026-10-29T08:41:27.988Z" updated: "2026-10-29T08:41:27.988Z" --- # Guest data model Updated: October 29, 2026 View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/property/integrations.md) page. | Field | Type | Required | Description | | ------------------------ | --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id | string | No | unique identifier for the guest | | created\_at | string (date-time) | No | when the guest was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | when the guest was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | the guest full name | | first\_name | string | No | the guest first name | | last\_name | string | No | the guest last name | | emails | PropertyEmail\[\] | No | email addresses of the guest | | emails\[\].email | string | Yes | the email address | | emails\[\].type | enum | No | the kind of email address Values: WORK, HOME, OTHER | | telephones | PropertyTelephone\[\] | No | telephone numbers of the guest | | telephones\[\].telephone | string | Yes | the telephone number | | telephones\[\].type | enum | No | the kind of telephone number Values: WORK, HOME, MOBILE, FAX, OTHER | | address | object | No | postal address of the guest | | 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 | | language | string | No | the guest preferred language (ISO 639-1) | | nationality | string | No | the guest nationality | | company\_name | string | No | the guest company name | | image\_url | string | No | URL of the guest picture | | notes | string | No | free-text notes about the guest | | 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 | ## 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 ```typescript 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] ```