Jump to Content
Guides
Recipes
API Reference
API Changelog
v1.0
Log In
API Reference
Log In
v1.0
Guides
Recipes
API Reference
API Changelog
Metrics
Search
JUMP TO
Authentication
Access Tokens
Generate an access token
post
Refresh an access token
post
Revoke an existing access token
delete
Centers
Center APIs
List all centers
get
Retrieve list of centers close to the base center
get
Retrieve a center
get
Retrieve Services for the Requested Center
get
Center - Categories
List all categories
get
Retrieve a category
get
Center - Rooms
List all rooms of a center
get
Retrieve a room of a center
get
Center - Employees
List all employees of a center
get
List all therapists of a center
get
List all blockout times of a center
get
Center attendance for a date
get
Retrieve the schedules of employees of a center
get
Center - Services
Retrieve therapist pricing and price scaling for a service of a center
get
List all services of a center
get
Retrieve a service offered in a center
get
Center - Packages
List all packages of a center
get
Center - Products
List all products of a center
get
Center - Memberships
List all memberships in a center
get
Retrieve the details of all the members of a center
get
Guests
Guest APIs
Create a guest
post
Create new guests using referral codes
post
Add a credit/debit card for a guest
post
Retrieve guest details
get
Retrieve the saved credit/debit cards of a guest
get
Search for a guest
get
List all appointments of a guest
get
List all products purchased by a guest
get
List all gift cards of a guest
get
List all prepaid cards of a guest
get
List all coupons of a guest
get
List the Series Packages of a Guest
get
List all relationships belonging to a guest
get
List all guests of a center
get
Verify the payable loyalty points of a guest
get
Retrieve the loyalty points history of a guest
get
Retrieve the merge history of guest records
get
Retrieve loyalty points of a guest (Earned/Redeemed)
get
Change/Cancel Auto-renewal of Guest Membership
put
Update details of a guest
put
Update billing address from the guest profile
put
Delete a guest's saved credit/debit card
delete
Delete relationship between guests
delete
Merge guests
put
Retrieve loyalty points of a guest
get
Registering Guest for Loyalty Points Tier
post
Guest Notes
Create a guest note
post
Retrieve a guest note
get
Retrieve the list of notes for a guest
get
Update a guest note
put
Delete a guest note
delete
Guest Form
Create a guest form
post
Retrieve a guest form
get
Update a guest form
put
Guest Memberships
List all memberships of a guest
get
Guest Membership Change Log
get
Fetch the pending membership collection amount of a guest
get
Cancel the membership of a guest
put
Freeze the membership of a guest
put
Unfreeze the membership of a guest
put
Guest Password
Reset the password of a guest
post
Update the password of a guest using the old password
put
Update the password of a guest using OTP
put
Employees
Employee APIs
Add employee with catalog information
post
Check-in an employee
post
Check-out an employee
post
Update the schedule of an employee
post
Retrieve the attendance of an employee
get
Retrieve employee details with payroll information
get
Delete the role of an employee
delete
Create custom field images
post
Get custom fields details
get
Update employment type and payroll information
patch
BlockOut Times
Create a blockout time for an employee
post
Create a recurring employee blockout time
post
Retrieve the blockout time of an employee
get
Retrieve all blockout times of an employee
get
List all blockout times of a center
get
List all blockout times types
get
Update the blockout time of an employee
put
Remove the blockout time of an employee
delete
Security Roles
Add the security role for an employee
post
Retrieve security roles of an employee
get
Rooms
BlockOut Times
Create the blockout time of a room
post
Create a recurring room blockout time
post
Retrieve the block out time of a room
get
Retrieve all blockout times of a room
get
Update the blockout time of a room
put
Remove a room blockout time
delete
Service Booking
Service Booking APIs
Create a service booking
post
Retrieve available slots for a service booking
get
Reserve a slot for a service booking
post
Confirm a service booking
post
Reschedule a service booking
post
Create bookings of service bundles and day packages
post
Gift Cards
Gift Card APIs
Create a gift card sale invoice after using a gift card template
post
List all occasions
get
Verify the balance of a gift card
get
Gift Card Templates
Create a gift card template with custom amount
post
Create a gift card template with services or day packages
post
List all templates
get
Get Center Predefined Gift Card Templates
get
Opportunities
Opportunities APIs
Create an opportunity
post
MetaData of the opportunities
get
Retrieve an opportunity
get
List all opportunities
get
Edit an opportunity
put
Notes
Add notes to an opportunity
post
List the notes of an opportunity
get
Appointments
Appointment APIs
Insert Guests' Feedback into Zenoti
post
Retrieve the list of appointments of a center
get
Retrieve the list of forms associated with an appointment
get
Retrieve the data of an appointment form
get
Retrieve the details of an appointment
get
Mark an appointment as No-Show
put
Mark the status of an appointment as checked-in
put
Undo the status of a checked-in appointment
put
Update Appointment Progress: Start, Open, or Complete
put
Organizations
Organization APIs
Retrieve the list of reasons
get
Retrieve the list of all countries
get
Retrieve the list of all states of a country
get
Retrieve the list of security roles in a center
get
Retrieve list of all security profiles
get
List all blockout times types
get
Get pay cycle settings of multiple centers
post
Reports
Reports APIs
Retrieve the collections report of a center
get
Retrieve the sales report of a center
get
Email notifications report API
post
Text Notifications Report API
post
Fetch the class details of an organization - Class report API
get
Fetch Employee audit report
post
Fetch collections report
post
Vendors
Vendor APIs
Retrieve the list of all vendors for an organization
get
Retrieve the list of all products associated to a vendor
get
Inventory
Inventory APIs
Retrieve the stock quantities of products
get
Retrieve the consumption details of products for a center
get
Retrieve the list of purchase orders for a center
get
Retrieve the list of transfer orders for a center
get
Retrieve the details of a purchase order
get
Retrieve the details of a transfer order
get
Associate Products with Centers in Bulk
put
Classes
Registration
Retrieve Class Registrations
get
Guest registration for the classes
post
Register a guest on Gympass
post
Cancel a guest's registration to a class
put
Cancel a guest's registration to a workshop
put
Check-in registered guests to classes
put
Undo the check-in of a guest to a class
put
Check-in registered guests to workshops
put
Undo check-in of a guest to a workshop
put
Fetch a list of booked users of a Workshop event
get
Register a guest to a workshop
post
Fetch user registrations for classes/workshops
get
Operations
Enroll or register a guest for a class session by an Admin
post
Retrieve the class session registrations of a guest
get
Cancel the registration of a class session
delete
Consumer
Create an invoice for the sale of a membership
post
Create an invoice for the sale of a series package
post
Book a class session
post
Close a series package sale invoice
post
Collect payment for a class booking by using the guest's saved credit/debit card
post
Close a membership sale invoice
post
Retrieve the list of payment methods
get
Retrieve the saved credit/debit cards of a guest
get
Retrieve the schedules of classes in multiple centers
get
Retrieve the session registrations of a center
get
Retrieve the memberships associated with classes
get
Retrieve the packages associated with classes
get
Cancel the payment transaction of a class booking
get
Collect payment for a class booking by using a new credit/debit card
get
Retrieve the session registrations of a guest
get
Cancel a booking registration
delete
Add Guest Pass user
post
Retrieve a list of all the Guest Pass users
get
Redeem a guest's Guest Pass membership
put
Retrieve a list of all the guest passes sent from or received by a user
get
Metrics
Shopify
Shopify APIs
Generate Shopify Multipass URL
get
Invoices
Invoice APIs
Create an invoice for the sale of a gift card
post
Apply a media campaign offer code on an invoice
post
Redeem the loyalty points of a guest
post
Send a gift card email to a guest
post
Retrieve invoice details
get
Retrieve invoice details including GST sequence details
get
Cancel a service booking
put
Send an email to a guest
put
Mark an appointment as confirm or undo confirm
put
Group Invoices
Create a group invoice
post
Send a group invoice email
post
Get group invoice details
get
Membership Invoices
Create an invoice for memberships
post
Add a membership to an invoice
put
Delete a membership from an invoice
delete
Product Invoices
Create an invoice for products
post
Add a product to an invoice
put
Delete a product from an invoice
delete
Package Invoices
Ability to redeem Series Regular Package in API
post
Ability to Sell Series Regular Packages in API
post
Invoice Payments
Collect invoice payment by using a guest's saved credit/debit card
post
Collect invoice payment by redeeming a guest's gift card
post
Collect invoice payment by using a guest's unsaved credit/debit card
post
Collect tip amount by using a guest's credit/debit card
post
Insert custom payment for an invoice into Zenoti
post
Close an invoice
post
Queue
Queue APIs
Fetch wait times of available stylists for a selected service
post
Fetch wait times of a center (with center_ids or geolocation)
post
Add a guest or group of guests to the Queue
post
Retrieve the list of all appointments in queue
get
Webhook Events
Webhook Events
Invoice Events
Invoice Closed
Guest Events
Guest Created
Guest Updated
Guest Deleted
Guest communication opted in
Guest communication opted out
Classes Schedule Events
Schedule Created
Schedule Updated
Schedule Cancelled
Schedule Deleted
Classes Booking Events
Booking Created
Booking Deleted
Booking Cancelled
Booking No Show
Booking Approved
Booking Rejected
Guest Membership Events
Guest Membership Created
Guest Membership Freeze
Guest Membership Unfreeze
Guest Membership Cancelled
Guest Membership Reinstate
GuestPass Redemption
Appointment Events
Appointment Started
Appointment Completed
Appointment Feedback Event
Feedback Started (Feedback V2)
Feedback Started (Feedback V1)
Appointment Group Events
Appointment Group Created
Appointment Group Status
Employee Events
Employee Deleted
Employee Created
Employee Updated
Guest Package Events
Guest Package Creation
Guest Package Redemption
Guest Package Redemption Reversal
Guest Package Status Update
Guest Package Validity Update
ePrescribe
Validate NPI details of a prescriber
put
Metrics
