For AI agents: visit https://docs.zenoti.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Zenoti APIs
GuidesRecipesAPI ReferenceAPI Changelog
v1.0

Log InZenoti APIs
API Reference
Log In
v1.0GuidesRecipesAPI ReferenceAPI Changelog

Authentication

  • Access Tokens
    • Generate an access tokenpost
    • Refresh an access tokenpost
    • Revoke an existing access tokendel

Centers

  • Center APIs
    • List all centersget
      • Retrieve list of centers close to the base centerget
    • Retrieve a centerget
    • Retrieve Services for the Requested Centerget
    • Deactivate or disable a centerput
  • Center - Categories
    • List all categoriesget
    • Retrieve a categoryget
  • Center - Rooms
    • List all rooms of a centerget
    • Retrieve a room of a centerget
  • Center - Employees
    • List all employees of a centerget
    • List all therapists of a centerget
    • List all blockout times of a centerget
    • Center attendance for a dateget
    • Retrieve the schedules of employees of a centerget
  • Center - Services
    • Retrieve therapist pricing and price scaling for a service of a centerget
    • List all services of a centerget
    • Retrieve a service offered in a centerget
  • Center - Packages
    • List all packages of a centerget
  • Center - Products
    • List all products of a centerget
  • Center - Memberships
    • List all memberships in a centerget
    • Retrieve the details of all the members of a centerget

Guests

  • Add V1 online guest creationpost
  • Guest APIs
    • Create a guestpost
      • Create new guests using referral codespost
    • Add a credit/debit card for a guestpost
    • Retrieve guest detailsget
    • Retrieve the saved credit/debit cards of a guestget
    • Search for a guestget
    • List all appointments of a guestget
    • List all products purchased by a guestget
    • List all gift cards of a guestget
    • List all prepaid cards of a guestget
    • List all coupons of a guestget
    • List the Series Packages of a Guestget
    • List all relationships belonging to a guestget
    • List all guests of a centerget
    • Verify the payable loyalty points of a guestget
    • Retrieve the loyalty points history of a guestget
    • Retrieve the merge history of guest recordsget
    • Retrieve loyalty points of a guest (Earned/Redeemed)get
    • Change/Cancel Auto-renewal of Guest Membershipput
    • Update details of a guestput
    • Update billing address from the guest profileput
    • Delete a guest's saved credit/debit carddel
    • Delete relationship between guestsdel
    • Merge guestsput
    • Retrieve loyalty points of a guestget
    • Registering Guest for Loyalty Points Tierpost
    • Activate guest emailput
    • Check Aveda Birthday Gift Availabilityget
    • Claim Aveda Birthday Giftpost
  • Guest Notes
    • Create a guest notepost
    • Retrieve a guest noteget
    • Retrieve the list of notes for a guestget
    • Update a guest noteput
    • Delete a guest notedel
  • Guest Form
    • Create a guest formpost
    • Retrieve a guest formget
    • Update a guest formput
  • Guest Memberships
    • List all memberships of a guestget
    • Guest Membership Change Logget
    • Fetch the pending membership collection amount of a guestget
    • Cancel the membership of a guestput
    • Freeze the membership of a guestput
    • Unfreeze the membership of a guestput
    • Create Membership Notifications in Bulkput
  • Guest Password
    • Reset the password of a guestpost
    • Update the password of a guest using the old passwordput
    • Update the password of a guest using OTPput

Employees

  • Employee APIs
    • Add employee with catalog informationpost
    • Retrieve employee details with payroll informationget
    • Update employee of the center with given catalog detailsput
    • Check-in an employeepost
    • Check-out an employeepost
    • Update the schedule of an employeepost
    • Retrieve the attendance of an employeeget
    • Create custom field imagespost
    • Get custom fields detailsget
    • Delete Employee Medical Licensesget
    • Fetch Employees with Form Review or Supervisor Accessget
  • BlockOut Times
    • Create a blockout time for an employeepost
    • Create a recurring employee blockout timepost
    • Retrieve the blockout time of an employeeget
    • Retrieve all blockout times of an employeeget
    • List all blockout times of a centerget
    • List all blockout times typesget
    • Update the blockout time of an employeeput
    • Remove the blockout time of an employeedel
  • Security Roles
    • Add the security role for an employeepost
    • Retrieve security roles of an employeeget
    • Delete the role of an employeedel

Rooms

  • BlockOut Times
    • Create the blockout time of a roompost
    • Create a recurring room blockout timepost
    • Retrieve the block out time of a roomget
    • Retrieve all blockout times of a roomget
    • Update the blockout time of a roomput
    • Remove a room blockout timedel

Service Booking

  • Service Booking APIs
    • Create a service bookingpost
      • Implement single therapist bookings for V1post
    • Retrieve available slots for a service bookingget
    • Reserve a slot for a service bookingpost
    • Confirm a service bookingpost
    • Reschedule a service bookingpost
    • Create bookings of service bundles and day packagespost

Gift Cards

  • Gift Card APIs
    • Create a gift card sale invoice after using a gift card templatepost
    • List all occasionsget
    • Verify the balance of a gift cardget
  • Gift Card Templates
    • Create a gift card template with custom amountpost
    • Create a gift card template with services or day packagespost
    • List all templatesget
    • Get Center Predefined Gift Card Templatesget

Opportunities

  • Opportunities APIs
    • Create an opportunitypost
    • MetaData of the opportunitiesget
    • Retrieve an opportunityget
    • List all opportunitiesget
    • Edit an opportunityput
  • Notes
    • Add notes to an opportunitypost
    • List the notes of an opportunityget

Appointments

  • Appointment APIs
    • Insert Guests' Feedback into Zenotipost
    • Retrieve the list of appointments of a centerget
    • Retrieve the list of forms associated with an appointmentget
    • Retrieve the data of an appointment formget
    • Retrieve the details of an appointmentget
    • Mark an appointment as No-Showput
    • Mark the status of an appointment as checked-input
    • Undo the status of a checked-in appointmentput
    • Update Appointment Progress: Start, Open, or Completeput

Organizations

  • Organization APIs
    • Retrieve the list of reasonsget
    • Retrieve the list of all countriesget
    • Retrieve the list of all states of a countryget
    • Retrieve the list of security roles in a centerget
    • Retrieve list of all security profilesget
    • List all blockout times typesget
    • Get pay cycle settings of multiple centerspost
    • Retrieve the organization settingsget

Reports

  • Reports APIs
    • Retrieve the collections report of a centerget
    • Retrieve the sales report of a centerget
    • Email notifications report APIpost
    • Text Notifications Report APIpost
    • Fetch the class details of an organization - Class report APIget
    • Fetch Employee audit reportpost
    • Generate sales accrual reportpost
    • Fetch collections reportpost

Vendors

  • Vendor APIs
    • Retrieve the list of all vendors for an organizationget
    • Retrieve the list of all products associated to a vendorget

Inventory

  • Inventory APIs
    • Retrieve the stock quantities of productsget
    • Retrieve the consumption details of products for a centerget
    • Retrieve the list of purchase orders for a centerget
    • Retrieve the list of transfer orders for a centerget
    • Retrieve the details of a purchase orderget
    • Retrieve the details of a transfer orderget
    • Associate Products with Centers in Bulkput
    • Retrieve a list of usersget

Classes

  • Registration
    • Retrieve Class Registrationsget
    • Guest registration for the classespost
    • Register a guest on Gympasspost
    • Cancel a guest's registration to a classput
    • Cancel a guest's registration to a workshopput
    • Check-in registered guests to classesput
    • Undo the check-in of a guest to a classput
    • Check-in registered guests to workshopsput
    • Undo check-in of a guest to a workshopput
    • Fetch a list of booked users of a Workshop eventget
    • Register a guest to a workshoppost
    • Fetch user registrations for classes/workshopsget
  • Operations
    • Enroll or register a guest for a class session by an Adminpost
    • Retrieve the class session registrations of a guestget
    • Cancel the registration of a class sessiondel
  • Consumer
    • Create an invoice for the sale of a membershippost
    • Create an invoice for the sale of a series packagepost
    • Book a class sessionpost
    • Close a series package sale invoicepost
    • Collect payment for a class booking by using the guest's saved credit/debit cardpost
    • Close a membership sale invoicepost
    • Retrieve the list of payment methodsget
    • Retrieve the saved credit/debit cards of a guestget
    • Retrieve the schedules of classes in multiple centersget
    • Retrieve the session registrations of a centerget
    • Retrieve the memberships associated with classesget
    • Retrieve the packages associated with classesget
    • Cancel the payment transaction of a class bookingget
    • Collect payment for a class booking by using a new credit/debit cardget
    • Retrieve the session registrations of a guestget
    • Cancel a booking registrationdel
    • Add Guest Pass userpost
    • Retrieve a list of all the Guest Pass usersget
    • Redeem a guest's Guest Pass membershipput
    • Retrieve a list of all the guest passes sent from or received by a userget
  • Metrics

Shopify

  • Shopify APIs
    • Generate Shopify Multipass URLget

Invoices

  • Invoice APIs
    • Create an invoice for the sale of a gift cardpost
    • Apply a media campaign offer code on an invoicepost
    • Redeem the loyalty points of a guestpost
    • Send a gift card email to a guestpost
    • Retrieve invoice detailsget
      • Retrieve invoice details including GST sequence detailsget
    • Cancel a service bookingput
    • Send an email to a guestput
    • Mark an appointment as confirm or undo confirmput
  • Group Invoices
    • Create a group invoicepost
    • Send a group invoice emailpost
    • Get group invoice detailsget
  • Membership Invoices
    • Create an invoice for membershipspost
    • Add a membership to an invoiceput
    • Delete a membership from an invoicedel
  • Product Invoices
    • Create an invoice for productspost
    • Add a product to an invoiceput
    • Delete a product from an invoicedel
  • Package Invoices
    • Ability to redeem Series Regular Package in APIpost
    • Ability to Sell Series Regular Packages in APIpost
  • Invoice Payments
    • Collect invoice payment by using a guest's saved credit/debit cardpost
    • Collect invoice payment by redeeming a guest's gift cardpost
    • Collect invoice payment by using a guest's unsaved credit/debit cardpost
    • Collect tip amount by using a guest's credit/debit cardpost
    • Close an invoicepost

Queue

  • Queue APIs
    • Fetch wait times of available stylists for a selected servicepost
    • Fetch wait times of a center (with center_ids or geolocation)post
    • Add a guest or group of guests to the Queuepost
    • Retrieve the list of all appointments in queueget

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 prescriberput

DIGITAL FORMS

  • Retrieve compliance statisticsget
  • Get guest consent for ZenScribeget
  • Add guest consent for ZenScribepost

Zenoti Mobile

  • Retrieve open invoicesget
  • Lock Invoiceput
  • Update Group Invoice Propertiesput
Powered by 

Service Booking APIs

Ensure that you use the Service Booking APIs in the following order:

Create a service booking

Retrieve available slots for a service booking

Reserve a slot for a service booking

Confirm the booking

Reschedule the booking

For more information, refer to:

https://docs.zenoti.com/docs/service-booking-apis

Updated about 3 years ago


Updated about 3 years ago