get
https://api.zenoti.com/v1/guests/
This API helps you to retrieve the details of a guest who has previously been created. You must specify the unique identifier of the guest as guest_id in the API request.This API also allows guests to view the details of another guest, provided they have a relationship defined in Zenoti. Also, only a host guest token can view another guest's details.
Response Details
GuestInfo
| Json property | Data type | Description |
|---|---|---|
| id | string | Unique identifier of the guest. |
| offline_id | Guid? | Offline ID for users created newly from offline mode. |
| code | string | User code of the guest. |
| center_id | String | Center ID of the guest. |
| preferred_service_id | string | Preferred service ID of the guest. |
| is_online_booking_blocked | bool | Indicates whether guest is blocked from online booking. |
| center_name | String | Center name of the guest. |
| created_date | DateTime | Date on which the guest is created. |
| can_edit_personal_info | bool | Indicates whether guest can edit personal info. |
| is_virtual_guest | bool | Indicates whether guest is a virtual guest. |
| is_guest_custom_form_filled | bool | Indicates whether guest custom form is filled. |
| personal_info | PersonalInformation | Personal information of the guest. |
| address_info | AddressInformation | Address information of the guest. |
| preferences | Preferences | Guest preferences. |
| tags | string[] | Tags associated with the guest. |
| referral | Referral | Referral details of the guest. |
| primary_employee | ObjectInfo | Primary employee preferred by the guest. |
| login_info | GuestLoginInfo | Login information of the guest. |
| guest_passes | List | Guest passes. |
| milestones | MilestoneData | Guest milestones. |
| guest_milestone_details | MilestoneLevelsWithTotalCheckIns | Milestone details with total check-ins. |
| last_updated_from | AppModuleType? | Last updated from source. |
| deposit_applicability | DepositApplicability | Deposit applicability. |
| additional_details | AdditionalDetails | Additional details of the guest. |
MilestoneLevelsWithTotalCheckIns
| Json property | Data type | Description |
|---|---|---|
| total_check_ins | int | Total check-ins. |
| current_level | MilestoneLevelDetails | Details of the achieved level. |
| next_level | MilestoneLevelDetails | Details of the future level. |
MilestoneLevelDetails
| Json property | Data type | Description |
|---|---|---|
| id | long | Milestone ID. |
| name | string | Milestone name. |
| required_check_ins | int | Required check-ins for the milestone. |
| level | int | Level of the milestone. |