API Changelog
Back to All

API Change Log – May 16th 2022 Release

over 2 years ago by Abhay Anumula

Check the API updates for this release.

API End PointsScenarioEarlier BehaviorNew BehaviorAPI Documentation Link
https://devapi.zenoti.com
/v1/guests/guestid
/loyalty_points		A new parameter
"ActionId" is added
in request object		NANANA
https://dev.zenoti.com
/v1/reports/sales
/cash_basis/flat_file		Added new property collected_as_on_date
in the SalesCashItem
object and
collected in the
SalesCashTotal
object of response.		Collected property
shows collected
till date and
having a conflict
with name and behaviour.		Collected till date property will show amount collected on the item till that date and collected will show that day's collected amount.NA
https://qaapi.zenotibeta.com
/api/Memberships
/GetMembershipForms?OrganizationId=
c3df0f67-50d0-
44e1-84d1-e5ee08af5625&
InvoiceItemId=
3c976353-db13-
4443-a5fb-66d604e8f41e&
UserMembershipId=
cd566282-231d-
4f8d-9112-
9f5fb767e6fe		A new param is added
in the
response object.		No change.
Added a new
parameter to
the response object.		No change. Added a new parameter to the response object.NA
http://devapi.zenoti.com/v1
/organizations
/5528ee09-5321-
4153-8ca7-
31c78d757dcb
/work_tasks		Adding an optional
parameter to get
org work tasks
which modifies
the flow of fetching
work tasks in the API.		Did not have the
optional parameter
to get org work tasks		Has optional parameter to get org work tasksNA
https://qaapi.zenotibeta.com
/v1
/guests
/017a4e11-c356-
4144-a9d9-93df5027b1ef
/products		This API is required
to show the
guest product history		NAThis API is required to show the guest product historyNA
https://qaapi.zenotibeta.com
/v1/guests
/017a4e11-c356-
4144-a9d9-
93df5027b1ef
/prepaidcards		Provides pagination
support		NAIn the request body user can pass page and size to get the pagination resultsNA
https://qaapi.zenotibeta.com
/v1/guests
/017a4e11-c356-4144-
a9d9-93df5027b1ef
/gift_cards		This API is required
to separate purchased
and received gift cards		NAUser can pass filter_by to get specific gift cardsNA
http://localhost:55244
/v1/guests
/5555E107-C192-
4EDC-862E-1
3BCE6C9153A
/loyalty_forms/
details		Added a new parameter form_urlDoes not return
form_url parameter
in the response		Returns an extra parameter form_url in the responseNA
https://apiurl.zenoti.com
/v1/organizations
/settings
/All		Get queue admin
settings section		Queue admin
settings section
was not provided		Provided Queue admin settings section.NA
https://devapi.zenoti.com/v1
/reports
/attendance_summary
/flat_file		Updated the API to
support Group-by
and Footers		NAUpdated the API in order to support Group-by and FootersNA
https://devapi.zenoti.com
/api/employees
/0d37e402-6048-
4ee0-b1e7-44229aae01d9		New parameter "is_virtual_employee"
is added in response.
It will be shown in response when Enable Waiting
Room is enabled at
both org and
employee's center.
If employee is a
virtual employee,
it returns true,
otherwise false.		is_virtual_employee
is not shown in
response		is_virtual_employee is shown in response when org and center setting is onNA
http://devapi.zenoti.com/api
/Catalog/Appointments
/GetWaitTimeForQueue		When "Require service selection while
adding guest to
queue" setting is
enabled at org level
and there is a
configured default
service for queue,
send DefaultServiceForQueue in api response		There was no DefaultServiceFor
Queue in API
response		This will send DefaultServiceForQueue in api response.NA
http://devapi.zenoti.com/api
/Appointments
/Queue		We are allowing access
of this api from MHCMA
user token, which was unauthorised earlier		Trying to access
this api with
MHCMA token
throws error:
User not authorised		Allows accessing of this API by the MHCMA user token.NA
https://devapi.zenoti.com/v1
/issues
/issue_id		New object has been
added in response		Guest details
contains "Name, Phone number and
Guest ID		Guest details contains "Name, Phone number, Guest ID , Guest code and Guest emailNA
https://api/Catalog
/Appointments
/ReserveSlots		No changes required
as they are already
available		NANANA
http://devapi.zenoti.com
/v1/organizations
/online_settings
/cma		Fetch either published
or draft setting
values based
on input.		Fetch published
setting values.		Fetch either published or draft setting values based on input.NA
http://devapi.zenoti.com
/v1/guests/guest_id
/memberships
/user_membership_id
/freeze		Added new parameters FreezeFeeType and
Comments to request.
Both parameters
are optional.		Values for
FreezeFeeType and
Comments are 1
and "Membership
Frozen By Guest
using API"
respectively
by default		If FreezeFeeType and Comments parameters are specified correctly in request they are considered else default values are considered.NA
http://devapi.zenoti.com/v1
/reports/memberships
/schedule_collections
/flat_file?page=1&size=1		1) Able to get
membership payment report by passing Invalid/Null
/Empty values for recurrence_statuses.
2)Able to get
membership payment report by passing Null/Empty
/without
Collection_status.		Able to get the
report for
above
mentioned invalid
parameters		Throws an error when we get Packages scheduled collection report with Invalid/Empty/Null value for statusNA
http://devapi.zenoti.com/v1
/reports/packages
/schedule_collections
/flat_file		1) Able to get
Packages scheduled
collection report by passing Null/Empty value
/without passing
Status

1) Able to get guest
feedback report by
passing Null/Empty
/without passing Invoice_status		Able to get the
report for above
mentioned invalid
parameters		Throws an error when we get Packages scheduled collection report with Invalid/Empty/Null value for statusNA
http://devapi.zenoti.com/v1
/reports/feedback
/flat_file		1) Able to get guest
feedback report by
passing Null/Empty/
without passing
Invoice_status

2)Able to get guest
feedback report by
passing Invalid/Empty
/Null
/without passing
Appointment
status		Able to get the
report for the
mentioned invalid
parameters		Throws an error when we get guest feedback report with Invalid/Empty/Null value for Appointment, invoice_statusNA
https:/
/phftest.zenotibeta.com
/v1/tokens		Login policies
enforced as a
part of employee
login enhancement.		Login policies
were not enforced.		Login policies enforced as a part of employee login enhancement.NA
https://devapi.zenoti.com/v1
/Centers?catalog_enabled=
true&expand=
zone&expand=
working_hours&expand=
catalog_settings&size=
100&page=7&services=
71265869-8380-
4c46-9d32-642c244dc402&Longitude=
78.3771953&Latitude=
17.4434646		Center amenities
enabled at center
settings for CMA		New parameters
were missing		Returns 2 new parameters in responseNA
http://devapi.zenoti.com/v1
/employees
/df13cccb-6eee-
49ab-adbe-cb0299f896be		Adding a parameter
include in payroll
which is ON by
default		Not changed the
existing behavior
but added extra
values in request
and response objects		Added one field (include_in_payroll) which is 1 by defaultNA
http://devapi.zenoti.com/v1
/employees
/df13cccb-6eee-
49ab-adbe-
cb0299f896be		Adding a parameter
include in payroll
which is ON by
default		Not changed the
existing behavior
but added extra
values in request
and response objects		Added one field (include_in_payroll) which is 1 by defaultAPI Docs Link
http://devapi.zenoti.com/v1
/employees		Adding a parameter
include in payroll
which is ON by
default		Not changed the
existing behavior
but added extra
values in request
and response objects		Added one field (include_in_payroll) which is 1 by defaultAPI Docs Link
https://qaaapi.zenotibeta.com
/v1/guests
/guest_id/tier		Even if the logged in
user has the role
permission, API
asks for the user
name and password
every time. Now made changes so that
user name and
password are optional,
and then verifying
the context user
permissions		Even if the logged
in user has the role
permission, API
asks for the user
name and password
every time.		Verifying the context user permission if the user name and password are not received in the requestNA
https://devapi.zenotibeta.com/v1
/invoices/InvoiceItem
/PriceChanges		Given centerid, all
future appointments
with no discounts
and adjustments
made should be
updated with new
price where finalprice>0		If therapistid and
serviceid is not passed,
throw an error that
either of them has
to be passed		If therapistid and serviceid is not passed, then updating future appts of centerNA
http://devapi.zenoti.com/api
/Appointments
/HtmlCustomData
/9BD7D750-B341-4CFD-B1A8-C3ABE4E2B4EF
/166FB797-
1313-41BD-9D4D-E5089B9A3FA3		Passed SourceApp
from context to
internal stored
procedure call for
form log changes.
No change in request or response.		No change in behaviorNo change in behaviorNA
http://devapi.zenoti.com/api
/Appointments
/810DF21C-9358-44B3-9A4B-F7DD152EAB0F
/GuestHtmlCustomData		Passed SourceApp
from context to
internal stored
procedure call for
form log changes.
No change in request or response.		No change in behaviorNo change in behaviorNA
http://devapi.zenoti.com/api
/Appointments
/810DF21C-9358-44B3-9A4B-F7DD152EAB0F
/CustomFormManualExpiry		Passed SourceApp
from context to
internal stored
procedure call for
form log changes.
No change in request or response.		No change in behaviorNo change in behaviorNA
http://devapi.zenoti.com/api
/Appointments/810DF21C-9358-44B3-9A4B-F7DD152EAB0F
/HtmlTagCustomData
/DA457E0B-69B1-
40D2-9A9D-1BA72C48BA66		Passed SourceApp
from context to
internal stored
procedure call for
form log changes.
No change in request or response.		No change in behaviorNo change in behaviorNA
http://devapi.zenoti.com
/api/Appointments
/810DF21C-9358-44B3-9A4B-F7DD152EAB0F
/HtmlCustomData		Passed SourceApp
from context to
internal stored
procedure call
for form log changes.
No change in request or response.		No change in behaviorNo change in behaviorNA
http://devapi.zenoti.com
/v1
/reports		To get the last
viewed time
information of report
to order/prioritize
data based on that		No last viewed
time for report.		get reports list with last viewed time information.NA
http://devapi.zenoti.com
/v1/guests/6EC4152A-
A671-4923-8223-B0CC405DAC74
/loyalty_forms		Passed SourceApp
from context to
internal stored
procedure call for
form log changes.
No change in request or response.		No change in
behavior		No change in behaviorNA
http://devapi.zenoti.com
/v1
/entities/31
/form_data		Passed SourceApp
from context to
internal stored
procedure call for
form log changes.
No change in request or response.		No change in
behavior		No change in behaviorNA
http://devapi.zenoti.com
/api/Catalog
/Guests
/GuestHtmlCustomData		Passed SourceApp
from context to
internal stored
procedure call for form log changes. No
change in request or
response.		No change in
behavior		No change in behaviorNA
http://devapi.zenoti.com/api
/Catalog/Appointments
/4E9AE2E2-C7BA-
4DFB-919C-DE06D2610E21/
HtmlTagCustomData
1DDD40EE-2688-
4FAF-9292-
336EBED9E9D5		Passed SourceApp
from context to
internal stored
procedure call
for form log changes.
No change in request or response.		No change in
behavior		No change in behaviorNA
http://devapi.zenoti.com/api
/Catalog
/Appointments
/4E9AE2E2-C7BA-
4DFB-919C-DE06D2610E21
/HtmlCustomData		Passed SourceApp from context to internal
stored procedure
call for form log
changes. No change
in request or response.		No change in
behavior		No change in behaviorNA
https://devapi.zenoti.com
/v1
/invoices
/d1fb6a44-
0d35-4992-aa96-24b58cd79369
/cancel		Guest should be
able to cancel
bookings for
family members.		Guests cannot
cancel bookings
for other guests.		Guest should be able to cancel bookings for family members.Cancel a service booking
https://webstoreapi.
zenoti.com/v1
/bookings
/7ac33976-
3af8-45b6-
87f8-e82e07ce1746
/slots/
confirm		Guest should be able to confirm bookings
for family members.		Guests cannot
confirm bookings
for other guests.		Guest should be able to confirm bookings for family members.Confirm a service booking
https://webstoreapi.
zenoti.com/v1
/bookings
/7ac33976-
3af8-45b6-87f8-
e82e07ce1746
/slots/reserve		Guest should be able to reserve the booking
for a family member.		Guest is unable to
reserve appointments
for other guests		Guest should be able to reserve appointments for family members.Reserve a slot for booking
https://webstoreapi.
zenoti.com/v1/bookings		A guest should be able
to create bookings
for family
members.		A guest could create
service bookings.		Guest should now be able to create service bookings.
https://webstoreapi.
zenoti.com/v1
/guests/d2da2994-
e4f0-40ea-b2cd-
a771ee83707a
/appointments		Relationship host guest
token should be
able to view
appointments
of family members		Guest token cannot
view appointment
list of another user		Guest token should be able to view appointments of another guest if he is part of a relationship.
https://webstoreapi.
zenoti.com/v1
/guests
/ef6a4b6a-8fd7-
43cc-babd-dfc80da0da3b		Relationship Host should
be able to view
the profile details
of a family member.		Guest token cannot
view profile details
of another user		Guest token should be allowed to view another guest's profile if he is in a relationship with the host.
https://webstoreapi.
zenoti.com/v1
/guests
/d2da2994-e4f0-
40ea-b2cd-a771ee83707a		Allow for relationship
hosts to be able to
update details of
family member
profiles.		Would not allow for
a guest to update
another guest's details		Should allow for a guest to update another guest details, if they are in a relationship and the guest token is the relationship host.
http://devapi.zenoti.com
/v1/opportunities
/OpportunityId
/Notes		If the logged in user
have Opportunity ->
Add permission in
Center A and
Opportunity ->
Edit permission in
center B ,logged
user must be able
to edit the opportunity
which belongs to
center B from
center A		API will be accessible
only when logged
in user have Edit
Permission in current
center .		API will be accessible even when logged in user have Add permission in current center(which is in context) and Edit permission in the center in which Opportunity belongs to .
http://devapi.zenoti.com/v1
/opportunities
/OpportunityId		If the logged in user
have Opportunity ->
Add permission in
Center A and
Opportunity ->
Edit permission in
center B ,logged user
must be able to
edit the opportunity
present in center
B from center A		API will be accessible
only when logged in
user have Edit
Permission in current
center .		API will be accessible even when logged in user have Add permission in current center(which is in context) and Edit permission in the center in which Opportunity belongs to .
http://devapi.zenoti.com
/v1/opportunities
/OpportunityId
/Notes		Should be able to get
the notes of an
opportunity even
when the logged
in user have
Add permission		API is accessible
when logged in
user have Edit
permission .		API will be accessible when logged in user have either Add or Edit permissions .
http://devapi.zenoti.com
/v1/opportunities		Excess details need
to accessed rather
than the ones
which we are
getting right now		Not changed the
existing behavior
but added extra
values in request
and response
objects		We have added few parameters(ExpandAllIds, ExpandAllOpportunityProperties) in request body and one parameter(include_permission_level) in path parameters .
http://apiurl.zenoti.com
/v1/reports
/packages
/schedule_collections
/flat_file		Added new column lastcollection
attempted, this
will get filled when
scheduled
payments collection
was attempted.
So last attempted
collection date
will get
populated in this field.		There are no changes
done in the
Request/URL of
the API. last_collection_attempted column will
not be present in
response model.		There are no changes done in the Request/URL of the API. Change done is in the response model. Added last_collection_attempted which shows date of last attempt made by scheduler to collect scheduled payment.NA
http://devapi.zenoti.com
/api/Catalog
/Appointments
/Availabletimes		When a group of
empty Slotbooking
model array sent
from the request,
response should
give open slots
without the
availability of service,
therapist & guest.		When an array of
empty slotbookings
were sent from the
request, it resulted
in slots based on
only first guest
service model object.		With this change, slots would come based on array of slotbooking objectNA
https://qaapi.zenotibeta.com
/api/Catalog
/Guests
/UserAppointments		When form is read
only, 6th bit in
SCD value should be 0		When form is read
only, 6th bit in
SCD value giving 1		When form is read only, 6th bit in SCD value should be 0NA
http://devapi.zenoti.com/api
/Catalog
/Services?CenterId=
d1fb6a44-0d35-
4992-aa96-24b58cd79369&size=
50&OrganizationId=
b5b9397d-d7bc-
444d-966f-6535e83c6ac3&category
Type=0&Attributes=
21,22,23,24		NAResults not sorted
by Service Display
Name		NANA
http://devapi.zenoti.com
/v1/Centers?
catalog_enabled=
true&page=
1&search_text=
Hyd&size=5		Able to search center
using zipcode,
address etc.		Used to return
all centers.		Added searching functionality to center list APINA
http://devapi.zenoti.com
/v1
/reports		Revamp of dashboardUsed to show only
V2 reports in the list.

No "version" property in reponse.		Include new parameter to show V1 reports.

Version parameter in response.		NA
http://devapi.zenoti.com/v1
/centers/?view_id=
A56292E4-8597-
48A0-B139-3F0386CB8DFA&expand=
taxgroups&page_num=-1		Added tax groups list
to each center
response if expand
array has taxgroups
string and also
added view_id
parameter to get
only centers which
are in that view id.		Doesnot support
taxgroups for
expand parameter
and view_id parameter.		supports expand= taxgroups which adds taxgroups array to that each center and if view_id is given then response contains only centers with in that view_id.NA
http://devapi.zenoti.com
/v1/products
/AB750E76-CAB0
-4835-810A-
A1B0EC23916D
/vendor_center
_associations?page=-1&expand=
price_info&view_id=
99EF216E-4636-
4680-80F9-B789AF9F5B05		NANANANA
https://qaapi.zenotibeta.
com
/api/Catalog
/Appointments/ConfirmReservation		Added entity related
changes		Does not support entitiesEntity mapping also works now for appointment bookingNA
http:/
/devapi.zenoti.com
/api/Catalog
/Services		Add entity related
details		Pull all service listingsAdd services listing related to entityNA