Use guest APIs
The guest APIs let you create and manage guest profiles, saved payment methods, notes, forms, memberships, loyalty points, and relationships. These APIs are used in nearly every integration workflow because guest records are required for bookings, invoices, and membership operations.
For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.
On this page
- Before you begin
- Guest profile operations
- Saved payment methods
- Guest notes
- Guest memberships
- Loyalty points
- Guest appointments and purchases
- Related articles
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.
Guest profile operations
Create a guest
POST /v1/guests
Creates a new guest record.
| Parameter | Type | Required | Description |
|---|---|---|---|
| personal_info.first_name | string | Yes | Guest's first name |
| personal_info.last_name | string | Yes | Guest's last name |
| personal_info.email | string | No | Email address |
| personal_info.mobile_phone | object | No | Mobile phone with country_code and number |
| personal_info.gender | enum | No | NotSpecified (-1), Male (1), Female (0), Other (3) |
| personal_info.date_of_birth | date | No | Date of birth |
| address_info | object | No | Address with address_1, city, country_id, state_id, zip_code |
| preferences | object | No | Communication preferences and loyalty opt-in |
| center_id | guid | Yes | Center to associate the guest with |
Response: Guest record with center_id, personal_info, code, address_info, preferences, tags, and primary_employee.
Search for a guest
GET /v1/guests/search
Searches for guests by name, email, phone, or other criteria.
Retrieve guest details
GET /v1/guests/{guest_id}
Retrieves full profile details for a specific guest.
Update guest details
PUT /v1/guests/{guest_id}
Updates an existing guest's profile information.
List all guests of a center
GET /v1/centers/{center_id}/guests
Retrieves all guests associated with a center with pagination support.
Merge guests
POST /v1/guests/merge
Merges duplicate guest records into a single profile.
Saved payment methods
Add a credit or debit card for a guest
POST /v1/guests/{guest_id}/cards
Saves a payment card to the guest's profile for future transactions.
Retrieve saved cards
GET /v1/guests/{guest_id}/cards
Retrieves all saved payment cards for a guest.
Delete a saved card
DELETE /v1/guests/{guest_id}/cards/{card_id}
Removes a saved payment card from the guest's profile.
Guest notes
Create a note for a guest
POST /v1/guests/{guest_id}/notes
Adds a note to a guest's profile.
Retrieve all notes for a guest
GET /v1/guests/{guest_id}/notes
Retrieves all notes attached to a guest's profile.
Guest memberships
Change membership
PUT /v1/guests/{guest_id}/memberships
Changes a guest's active membership to a different plan.
Cancel auto-renewal membership
PUT /v1/guests/{guest_id}/memberships/cancel_auto_renewal
Cancels the auto-renewal on a guest's recurring membership.
Loyalty points
Verify loyalty points
GET /v1/guests/{guest_id}/loyalty_points/verify
Checks a guest's current loyalty points balance and eligibility for redemption.
Retrieve loyalty points history
GET /v1/guests/{guest_id}/loyalty_points/history
Retrieves the history of loyalty points earned and redeemed by a guest.
Guest appointments and purchases
List all appointments of a guest
GET /v1/guests/{guest_id}/appointments
Retrieves a guest's appointment history with pagination.
| Parameter | Type | Required | Description |
|---|---|---|---|
| guest_id | guid | Yes | Guest identifier |
| page | integer | No | Page number |
| size | integer | No | Records per page |
| start_date | datetime | No | Filter from date |
| end_date | datetime | No | Filter until date |
Response: appointments (array with appointment_group_id, invoice_id, invoice_status (0=Open, 1=Processed, 4=Closed, 99=Voided), appointment_services, is_feedback_submitted), page_info.
List all gift cards of a guest
GET /v1/guests/{guest_id}/gift_cards
Retrieves all gift cards associated with a guest.
Tips
- Use the search endpoint before creating a guest to avoid duplicate records.
- When creating guests for booking workflows, include at minimum
first_name,last_name, and eitheremailormobile_phonefor communication. - Use the merge API to consolidate duplicate guest records that may have been created across different channels.