API change log
API Change log - August 23, 2023
API Endpoint: {api_url} /api/Services
Scenario: The API fetches the list of all services in a center. Earlier, the API returned only the list of services and not the service rank. Now, the API fetches both the list of services and the rankings of each service for the Webstore.
Earlier behavior: The API returned only the list of services and not the service rank
New behavior: The API fetches the list of all services in a center along with the ranking of each service for the Webstore.
API documentation link: NA
API Change Log - June 8, 2023
Guests
API endpoint: {api_url}/v1/guests/{guestID}
Scenario: When retrieving guest data, if there is data available for the LastUpdatedFrom property, it will be included in the response.
Earlier behavior: The LastUpdatedFrom property was not present.
New behavior: To keep track of the last update from the source, in the tbluser table, to the GuestInfo model, the LastUpdatedFrom property is added.
API documentation link: https://docs.zenoti.com/reference/retrieve-guest-details
API endpoint: {api_url}/v1/guests/{guest_id}/membership/{collection_id}/collection_attempts
Scenario: Retrieving the recurrence collection attempts report.
Earlier behavior: NA
New behavior: The API now supports retrieving the recurrence collection attempts report. It will provide the necessary data for the specified guest ID and membership ID.
API documentation link: NA
API endpoint: {api_url}/v1/guests/{guest_id}
Scenario: Retrieving guests' deposit applicability.
Earlier behavior: The previous version of the API was not returning guests' deposit applicability.
New behavior: The modified API will now return guests' deposit applicability.
API documentation link: https://docs.zenoti.com/reference/retrieve-guest-details
Appointments
API endpoint: {api_url}/Catalog/Appointments/ReserveSlots
Scenario: Checking the deposit applicability for guests during slot reservation.
Earlier behavior: Previously, the API was returning the deposit amount based on the guest's deposit applicability.
New behavior: The API will now return the deposit amount based on the guest's deposit applicability using the new settings.
API documentation link: NA
API Change Log – May 17, 2023
Updates for this release.
Loyalty
API Endpoint: {api_url}/v1/guests
Scenario: This API helps you create a guest
Earlier behavior: In the user Webhooks, the following information was not available:
Country name
State name
Gender
STD code in Phone number
New behavior: In the user Webhooks, the following information is now available:
Country name
State name
Gender
STD code in Phone number
API documentation link: https://docs.zenoti.com/reference/create-a-guest
API endpoint: {api_url /v1/guests/guestid/points
Scenario: This API fetches the loyalty point details of a guest.
Earlier behavior: The API did not fetch the actual enrollment date of the guest in the loyalty program.
New behavior: The following parameter has been added to fetch the enrollment date of the guest to the loyalty program.
API documentation link:
Payments
API endpoint: {api_url}/v1/payments/onboarding/merchants/merchant_id/email
Scenario: This new API is used to update the Adyen business email.
Earlier behavior: NA
New behavior: This API is used to update the Adyen business email.
API documentation link:
API endpoint: {api_url} /v1/payouts/settings
Scenario: This new API is used to update tips payout configuration settings.
Earlier behavior: NA
New behavior: This new API is used to update tips payout configuration settings.
API documentation link:
API endpoint: {api_url}/v1/payments/{processor_id}/rates
Scenario: This API is used to retrieve the rates of a given processor ID that are configured in the organization or center for Zenoti payments
Earlier behavior: Add-on rates were not available.
New behavior: Added new add-on rates when the T+1 payout schedule is enabled.
API documentation link:
API endpoint: {api_url}/v1/guests/{guest_id}/accounts?center_id={center_id}&source=1&get_expired_cards=false
Scenario: A guest can save the card by swiping it with the card reader. The business needs to save this newly added card as a backup account for a membership.
Earlier behavior: The created date field was not present in the API response.
New behavior: The created date field is now present in the API response.
API documentation link: NA
Data IO
API endpoint: {api_url} /v1/data_io_operations/{id}/cancel
Scenario: This new API is used to cancel data IO operation that was queued by the current user.
Earlier behavior: NA
New behavior: This API is used to cancel data IO operation that was queued by the current user
API documentation link:
API endpoint: {api_url} /v1/data_io_operations/{id}/{file_Type}
Scenario: This new API is used to get the pre-signed S3 bucket URL of the log file or data file of a data io operation.
Earlier behavior: NA
New behavior: This new API is used to get the pre-signed S3 bucket URL of the log file or data file of a data io operation.
API documentation link:
API endpoint: {api_url} /v1/data_io_operations
Scenario: This new API fetches the list of items from import/export operations.
Earlier behavior: NA
New behavior: This new API fetches the list of items from import/export operations.
API documentation link:
Inventory
API endpoint: {api_url}/v1/inventory/orders/products?Page=1&Size=10
Scenario: This new API is used to get the list of products associated to a vendor and center ordered by sales/consumption of the product.
Earlier behavior: NA
New behavior: This new API is used to get the list of products associated to a vendor and center ordered by sales/consumption of the product.
API documentation link: NA
Point of sale
API endpoint: {api_url}/ v1/offline_sync/GuestSearch
Scenario: This new API is used to integrate new APIs into new OfflineSync Controller.
Earlier behavior: NA
New behavior: This new API is used to integrate new APIs into new OfflineSync Controller.
API documentation link: NA
API endpoint: {api_url }/api/Invoices/bulk_close}
Scenario: This new API is used to close invoices in bulk.
Earlier behavior: NA
New behavior: This new API is used to close invoices in bulk.
API documentation link: NA
API endpoint: {api_url }/api/v2.0/Invoices/bulk_update
Scenario: This new API is used to update invoices in bulk.
Earlier behavior: NA
New behavior: This new API is used to update invoices in bulk.
API documentation link: NA
API endpoint: {api_url }/api/v2.0/Invoices/invoices_by_date?CenterId={Center_ID}&StartDate={Start_Date}&EndDate={End_Date}&PageNumber=1&NumberOfRecords=10
Scenario: This new API is used to fetch invoices of a center for a specified date range in bulk.
Earlier behavior: NA
New behavior: This new API is used to fetch invoices of a center for a specified date range in bulk.
API documentation link: NA
API endpoint: {api_url }/api/ Invoices/bulk_add
Scenario: This new API is used to add invoices of a center in bulk.
Earlier behavior: NA
New behavior: This new API is used to add invoices of a center in bulk.
API documentation link: NA
API endpoint: {api_url }/ v1/employees/bulk_declared_tips
Scenario: This new API is used to declare cash tips in bulk.
Earlier behavior: NA
New behavior: This new API is used to declare cash tips in bulk.
API documentation link: NA
API endpoint: {api_url }/api/Products
Scenario: This API is used to fetch the products of a center.
Earlier behavior: NA
New behavior: This API is used to fetch the products of a center.
API documentation link: NA
API endpoint: {api_url }/api/Services
Scenario: This API is used to fetch the services of a center.
Earlier behavior: NA
New behavior: This API is used to fetch the services of a center.
API documentation link: NA
Memberships
API endpoint: {api_url} /v1/guests/{guest_id}/memberships/{user_membership_id}/payment_collection_details?collection_id={collection_id}
Scenario: This new API is used to fetch dunning payment collection details of a membership.
Earlier behavior: NA
New behavior: This new API is used to fetch dunning payment collection details of a membership.
API documentation link: NA
Consumer Mobile Application
API endpoint: api/Catalog/Appointments/AvailableTimes
Scenario: The Available Times API now displays appointments booked through mobile as booking_source=Mobile.
Earlier behavior: The API displayed the booking source of appointments booked through CMA as null.
New behavior: The Available Times API now displays appointments booked through mobile as booking_source=Mobile.
API documentation link: NA
Employee
API endpoint: {api_url} /v1/employees/{employee_id}/checkin
Scenario: This API helps you to check-in an employee.
Earlier behavior: No validation to check if the employee is checking in before the completion of the break period, if the break period feature is enabled.
New behavior: Added validation to check if the employee is checking in before the completion of the break period, if the break period feature is enabled.
API documentation link: NA
API endpoint: {api_url} /v1/employees/{employee_id}/checkout
Scenario: This API helps you to check-out an employee.
Earlier behavior: A user could not check out for a mandatory break.
New behavior: A user can check out for a mandatory break.
API documentation link: NA
API endpoint: {api_url}/api/Centers/{center_id}/Settings
Scenario: This API helps you to fetch center settings.
Earlier behavior: Setting for break period was not displayed in API response.
New behavior: Added the setting for break period in API response.
API documentation link: NA
API endpoint: {api_url} /v1/centers/{center_id}/attendance
Scenario: This API helps you to fetch employee attendance for a center.
Earlier behavior: The API could not fetch break periods.
New behavior: The API can now fetch break periods.
API documentation link: NA
API endpoint: {api_url} /v1/centers/{center_id}/attendance
Scenario: This API helps you to fetch employee attendance for a center.
Earlier behavior: The API could not fetch break periods.
New behavior: The API can now fetch break periods.
API documentation link: NA
API endpoint: {api_url} /v1/employees/checkout
Scenario: This API helps you to check out an employee.
Earlier behavior: A user could not check out for a mandatory break.
New behavior: A user can check out for a mandatory break.
API documentation link: NA
API endpoint: {api_url} /v1/employees/checkin
Scenario: This API helps you to check in an employee.
Earlier behavior: No validation to check if the employee is checking in before the completion of the break period, if the break period feature is enabled.
New behavior: Added validation to check if the employee is checking in before the completion of the break period, if the break period feature is enabled.
API documentation link: NA
API change log – April 19, 2023
Check out the updates for this release.
Employee
API endpoint: {api_url}/v1/reports/zone_payroll/summary/flat_file
Scenario: This API fetches the zone-level payroll data
Earlier behavior: No support to fetch data for zone-level payroll data for selected pay period.
New behavior: Fetches zone-level payroll data based on parameters.
API documentation link: NA
API endpoint: {api_url}/v1/payroll/pay_periods/list?view_mode=1&view_id=219381B2-F010-42A2-8CF4-4292889B0E81
Scenario: This API fetches pay periods for zone-level payroll report.
Earlier behavior: NA
New behavior: This API fetches pay periods for zone-level payroll report.
API documentation link: NA
API endpoint: {api_url}/v1/payroll/compute_commissions
Scenario: This API allows the user to calculate org-level payroll.
Earlier behavior: NA
New behavior: This API allows the user to calculate org-level payroll.
API documentation link: NA
Consumer Mobile App
API endpoint: {apiurl}/api/catalog/guests/userappointments?requesttype=0&page=1&size=20
Scenario: This API allows users to differentiate between queue and regular appointments.
Earlier behavior: The user could not differentiate whether the appointment was a queue appointment or a regular appointment.
New behavior: The user can now differentiate whether the appointment was a queue appointment or a regular appointment.
API documentation link: NA
API endpoint: {api_url}/v1/Catalog/Appointments/GetWaitTimeForQueue
Scenario: This API allows users to understand whether an appointment is booked through the queue-hybrid mode.
Earlier behavior: There was no setting to recognize queue-hybrid mode appointments for CMA.
New behavior:Two parameters are added to recognize queue-hybrid mode appointments for CMA at center level.
API documentation link: NA
API Change Log - April 05, 2023
Check out the updates for this release.
Integrations
Webhook event: Invoice.Closed
Scenario: This automation notifies your application whenever an invoice is closed in Zenoti.
Earlier behavior: The Invoice.Closed Webhook does not trigger when a guest purchases gift cards, memberships, or packages through Webstore.
New behavior: The Invoice.Closed Webhook triggers when a guest purchases gift cards, memberships, or packages through Webstore.
API Change Log - March 23, 2023
Check out the updates for this release.
Webstore and CMA
API endpoint: {api_url}/v1/guests/{guest_id}/waitlist?page=1&size=10
Scenario: This API fetches the appointment details of the guest present on the waitlist.
Earlier behavior: NA
New behavior: This backend API allows a guest to fetch their appointment details on Webstore or CMA while on the waitlist.
API documentation link: NA
API endpoint: {api_url}/v1/centers/{center_id}/waitlist/{id}
Scenario: This API removes the guest from the waitlist.
Earlier behavior: NA
New behavior: This API allows a guest to remove themselves from the waitlist of the center.
API documentation link: NA
API endpoint: {api_url}/v1/centers/{center_id}/waitlist
Scenario: This API allows the guest to add themselves to the waitlist.
Earlier behavior: NA
New behavior: This API allows the guest to add themselves to the waitlist of the center through Webstore or CMA.
API documentation link: NA
Loyalty
API endpoint: {apiurl}/v1/guests/search
Scenario: With this release, Zenoti allows you to search for guests at the zone level.
Earlier behavior: The search was only limited to the center level.
New behavior: An additional parameter, search_across_zone, now allows you to search for a guest at the zone level.
To search for guests within the zone, you must ensure to pass the parameter as true in the following way:
search_across_zone = true
API documentation link: Search for a guest
API Change Log - March 8, 2023
Check out the API updates for this release.
Payments
API endpoint: {apiurl}/v1/payments/billing_frequency?organization_id={org_id}
Scenario: New API to retrieve billing frequencies of an organization
Earlier behavior: NA
New behavior: Use this API to fetch the billing frequencies of an organization. The billing frequencies are useful in determining the pricing model of the business.
API documentation link: NA
Marketing
API endpoint: {api_url}/v1/invoices/{invoice_id}/campaigns/auto_apply
Scenario: New API to apply a campaign on an invoice automatically.
Earlier behavior: NA
New behavior: Use this API to automatically apply a campaign to a single or group invoice.
API documentation link: NA
Reports v2
API endpoint: {apiurl}/v1/reports/payroll/summary/flat_file
Scenario: Added the following parameters to the response.
break_time_hours
vacation_hours
vacation_pay_rate
vacation_pay
holiday_pay_rate
holiday_hours
holiday_pay
Earlier behavior: The API fetched payroll summary report for the selected pay period.
New behavior: The API will provide additional details apart from fetching the payroll summary report.
API documentation link: NA
Employee
API endpoint: {api_url}/v1/employees/{employee_id}?expand=payroll_info
Scenario: Added the following parameters to the response object:
vacation_pay_rate
holiday_pay_rate
Earlier behavior: The API fetched employee details such as personal info, contact details, job info, and preference info.
New behavior: With this update, the API will also fetch details such as vacation_pay_rate, and holiday_pay_rate.
API documentation link: Retrieve employee details with payroll information.
API endpoint: {api_url}/v1/employees/{employee_id}
Scenario: Added the following parameters to the response object:
vacation_pay_rate
holiday_pay_rate
Earlier behavior: The API updated the employee details such as login, job, preference, and payroll information.
New behavior: With this update, in the response object, the API will contain vacation_pay_rate and the holiday_pay_rate.
API documentation link: Update an employee of the center.
API endpoint: {api_url}/v1/employees?expand=payroll_info
Scenario: Added the following parameters to the response object:
vacation_pay_rate
holiday_pay_rate
Earlier behavior: The API created a new employee in the center.
New behavior: With this update, in the response object, the API will contain vacation_pay_rate and holiday_pay_rate.
API documentation link: Add employee with catalog information.
API Change Log – February 15th 2023
Check out the API updates for this release.
Employee
API endpoint: http://{apiurl}/v1/employees/employeeid/signature
Scenario: Added the following parameters in response:
employee_name
employee_user_id
Earlier behavior: Additional parameters were not mentioned in the response.
New behavior: Additional parameters will now allow users to check the employee’s name and user id.
API documentation link: NA
API endpoint: http://{apiurl}/api/employee/therapists
Scenario: Therapist description is now displayed in response to the “List all therapists of a center” API.
Earlier behavior: The therapist’s description was not displayed.
New behavior: With this release, users will see the therapist's description in response to the list of all therapists of a center.
API documentation link: List all therapists of a center
Memberships
API endpoint: http://{apiurl}/v1/guests/{guest_id}/memberships/{membership_id}/post_pone
Scenario: Use this API to delay annual or regular scheduled payments for memberships.
Earlier behavior: Regular and scheduled payments could not be changed or altered.
New behavior: With this release, you can postpone or delay a regular or scheduled membership payment.
API documentation link: NA
Forms
API endpoint: http://{apiurl}/v1/reports/forms/review/flat_file
Scenario: Added form filters and review stats in the request body.
Earlier behavior: Was returning form data based on existing filters.
New behavior: With this release, newly added parameters will return updated filters and review statistics.
API documentation link: NA
API endpoint: http://{apiurl}/v1/assets
Scenario: Added customforms parameter.
Earlier behavior: NA
New behavior: With this release, we have added a new parameter called customforms.
API documentation link: NA
API endpoint: http://{apiurl}/api/Appointments/appointment_id/HtmlCustomData?ViewContext=1&VersionNo=0
Scenario: Added a new parameter “IsFormReview” to the response object GetHtmlCustomDataResponse.
Earlier behavior: NA
New behavior: With this release, we are adding a new parameter “IsFormReview” in the response.
API documentation link: NA
API endpoint: http://{apiurl}/v1/forms/object_operators?object_type_id={object_type_id}&object_id={object_id}
Scenario: New API to fetch object operators.
Earlier behavior: NA
New behavior: Use this API to fetch all the object operators for your forms.
API documentation link: NA
API endpoint: http://{apiurl}/v1/forms/form_id/objects
Scenario: New API to fetch a form’s fields.
Earlier behavior: NA
New behavior: This new API will take a form as an input parameter and return the list of fields configured in the form. This API supports both v2 and v3 forms.
API documentation link: NA
API endpoint: http://{apiurl}/v1/classes/custom_forms
Scenario: Hardcoded job level parameter in the custom_forms API.
Earlier behavior: Currently, this API does not return job-level parameters which allow us to fetch the filteredforms.
New behavior: With this release, we have added a new parameter called job level.
API documentation link: NA
Donations
API endpoint: http://{{url}}/v1/reports/donations/flat_file?page={page}&size={size}
Scenario: New API to fetch the Donations v2 report.
Earlier behavior: NA
New behavior: Use this API to fetch the donations v2 report. You must specify the center_id, start_date, and end_date for the API to run.
API documentation link: NA
API Change Log January 18th, 2023
Check the API updates for this release.
Employee
API endpoint: {api_url} /v1/reports/attendance_summary/flat_file
Scenario: Fetch the attendance details of the employees in the organization, including their schedules and check-ins.
Earlier behavior: There was no check-in filter to filter the attendance details.
New behavior: Now, you can use the check-in filter to filter the attendance details.
API documentation link: NA
API Change Log December 8th, 2022
Check the API updates for this release.
Employee
API endpoint: {apiurl}/v1/employees/{employee_id}/history?type=1
Scenario: Fetch the employee’s payroll plan history.
Earlier behavior: NA
New behavior: This new API allows you to fetch the payroll plan history of the employee.
API documentation link: NA
Memberships
API endpoint:{apiurl}/v1/guests/{guest_id}/memberships/{membership_id}/addon_member/{addon_member_id}
Scenario: Use this API to delete a guest (member) from a membership.
Earlier behavior: NA
New behavior: This new API allows you to delete the members present in a membership.
API documentation link: NA
API endpoint: {apiurl}/v1/guests/{guest_id}/memberships/{membership_id}/addon_member
Scenario: Use this API to add a guest (member) to an existing membership.
Earlier behavior: NA
New behavior: This new API allows you to add a new member (guest) to an existing membership.
API documentation link: NA
ezConnect
API endpoint: {apiurl}/v1/zconnect/groups
Scenario: Use this API to edit the group when sending a bulk SMS.
Earlier behavior: NA
New behavior: This new API allows you to edit the group of recipients when sending bulk text messages on ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups
Scenario: Use this API to create groups for sending bulk SMS.
Earlier behavior: NA
New behavior: This new API allows you to create a group of recipients for sending bulk text messages on ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups
Scenario: Use this API to add a contact to an existing group.
Earlier behavior: NA
New behavior: This new API allows you to an existing contact to a group. Use the group to send bulk SMS on ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups/delete_contact?center_id={center_id}&group_id={group_id}&user_id={user_id}
Scenario: Use this API to delete a contact from a group.
Earlier behavior: NA
New behavior: This new API allows you to delete an existing contact present in the group.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups?center_id={center_id}&group_id={group_id}
Scenario: Use this API to delete the entire group.
Earlier behavior: NA
New behavior: This new API allows you to delete an existing group in ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/group_contacts?group_id={group_id}&search_text=&page=1&size=10
Scenario: Use this API to get the contact details of all the guests in a group.
Earlier behavior: NA
New behavior: This new API allows you to fetch the contact information of all the guests inside an existing group.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups?center_id={center_id}&search_text=&page=1&size=10
Scenario: Use this API to fetch all the groups created in ezConnect.
Earlier behavior: NA
New behavior: This new API allows you to fetch all the groups that are present in ezConnect.
API documentation link: NA
API Change Log December 8th, 2022
Check the API updates for this release.
Employee
API endpoint: {apiurl}/v1/employees/{employee_id}/history?type=1
Scenario: Fetch the employee’s payroll plan history.
Earlier behavior: NA
New behavior: This new API allows you to fetch the payroll plan history of the employee.
API documentation link: NA
Memberships
API endpoint:{apiurl}/v1/guests/{guest_id}/memberships/{membership_id}/addon_member/{addon_member_id}
Scenario: Use this API to delete a guest (member) from a membership.
Earlier behavior: NA
New behavior: This new API allows you to delete the members present in a membership.
API documentation link: NA
API endpoint: {apiurl}/v1/guests/{guest_id}/memberships/{membership_id}/addon_member
Scenario: Use this API to add a guest (member) to an existing membership.
Earlier behavior: NA
New behavior: This new API allows you to add a new member (guest) to an existing membership.
API documentation link: NA
ezConnect
API endpoint: {apiurl}/v1/zconnect/groups
Scenario: Use this API to edit the group when sending a bulk SMS.
Earlier behavior: NA
New behavior: This new API allows you to edit the group of recipients when sending bulk text messages on ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups
Scenario: Use this API to create groups for sending bulk SMS.
Earlier behavior: NA
New behavior: This new API allows you to create a group of recipients for sending bulk text messages on ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups
Scenario: Use this API to add a contact to an existing group.
Earlier behavior: NA
New behavior: This new API allows you to an existing contact to a group. Use the group to send bulk SMS on ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups/delete_contact?center_id={center_id}&group_id={group_id}&user_id={user_id}
Scenario: Use this API to delete a contact from a group.
Earlier behavior: NA
New behavior: This new API allows you to delete an existing contact present in the group.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups?center_id={center_id}&group_id={group_id}
Scenario: Use this API to delete the entire group.
Earlier behavior: NA
New behavior: This new API allows you to delete an existing group in ezConnect.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/group_contacts?group_id={group_id}&search_text=&page=1&size=10
Scenario: Use this API to get the contact details of all the guests in a group.
Earlier behavior: NA
New behavior: This new API allows you to fetch the contact information of all the guests inside an existing group.
API documentation link: NA
API endpoint: {apiurl}/v1/zconnect/groups?center_id={center_id}&search_text=&page=1&size=10
Scenario: Use this API to fetch all the groups created in ezConnect.
Earlier behavior: NA
New behavior: This new API allows you to fetch all the groups that are present in ezConnect.
API documentation link: NA