API Change Log – February 28, 2024

Employee

•API endpoint: GET {api_url}/v1/employees/{employee_id}?expand=payroll_info
•Scenario: To cater to the new Advanced overtime setting, this API has been enhanced to retrieve the employee details of a center where the new Advanced overtime parameter is introduced.
•Earlier behavior: Couldn’t check the Advanced overtime setting before retrieving employee details.
•New behavior: This API can now check the Advanced overtime setting and retrieve the employee details related to advanced overtime.
•API documentation link: https://docs.zenoti.com/reference/add-employee-with-catalog-information

Employee

•API endpoint: PUT {api_url}/v1/employees/{employee_id}
•Scenario: To cater to the new Advanced overtime setting, this API has been enhanced to update the employee details of a center where the new Advanced overtime parameter is introduced.
•Earlier behavior: Couldn’t update employee details with the Advanced overtime setting.
•New behavior: Can update employee profiles by applying the new Advanced overtime setting.
•API documentation link: https://docs.zenoti.com/reference/add-employee-with-catalog-information

Employee

•API endpoint: POST {api_url}/v1/employees
•Scenario: To cater to the new Advanced overtime setting, this API has been enhanced to create a new employee in a center where the new Advanced overtime parameter is introduced.
•Earlier behavior: Couldn’t create employee profiles with the Advanced overtime configuration.
•New behavior: Can create employee profiles by applying the new Advanced overtime setting.
•API documentation link: https://docs.zenoti.com/reference/add-employee-with-catalog-information

Guest

•API endpoint: GET {api_url}/v1/guests/{guest_id}
•Scenario: This API has been improved to retrieve information about the milestone parameter of a guest who is subject to a service deposit, along with the reasons for the deposit requirement (if the user is a new guest/has a certain number of no-shows/doesn’t have a package or membership).
•Earlier behavior: Couldn’t support for the service deposit applicability.
•New behavior: Retrieves guest information and checks for the applicability of service deposits along with the reasons.
•API documentation link: https://docs.zenoti.com/reference/retrieve-guest-details

Guest

•API endpoint: GET {api_url}/v1/guests/{guest_id}/milestones
•Scenario: This API has been improved to retrieve a guest’s details including the new milestone parameter set by the business under Fitness > Milestones (on Zenoti).
•Earlier behavior: n/a
•New behavior: Retrieves guest’s milestone details.
•API documentation link:

Guest

•API endpoint: GET {api_url}/v1/guests/{guest_id}/registrations
•Scenario: This API has been improved to retrieve a guest’s details including the new guest_milestone_details parameter set by the business in the guest profile.
•Earlier behavior: Didn’t include the milestone details.
•New behavior: Retrieves guest’s milestone details from the guest profile.
•API documentation link:

Guest

•API endpoint: GET {api_url}/v1/classes/{class_id}/registrations
•Scenario: This API has been improved to retrieve guest membership details along with other details with the new user_memberships parameter.
•Earlier behavior: Didn’t include guest membership details.
•New behavior: The API now retrieves membership details too.
•API documentation link:

Guest

•API endpoint: POST {api_url}/v1/organizations/milestones
•Scenario: This API has been created to create milestones at the organization level for classes that the guests take with the new milestones parameter.
•Earlier behavior: n/a
•New behavior: Creates milestones at the organization level for classes.
•API documentation link:

Guest

•API endpoint: GET {api_url}/v1/organizations/milestones
•Scenario: This API has been created to retrieve and list all available class milestones with the new milestones parameter.
•Earlier behavior: n/a
•New behavior: Retrieves all available class milestones
•API documentation link:

Guest

•API endpoint: PUT {api_url}/v1/organizations/milestones/{milestone_id}
•Scenario: This API has been created to update class milestone details at the organization level new milestones parameter.
•Earlier behavior: n/a
•New behavior: Updates milestone details at the organization level.
•API documentation link:

Guest

•API endpoint: DELETE {api_url}/v1/organizations/milestones/{milestone_id}
•Scenario: This API has been created to delete class milestone details at the organization level new milestones parameter.
•Earlier behavior: n/a
•New behavior: Deletes milestone details at the organization level.
•API documentation link:

Membership

•API endpoint: PUT {api_url}/v1/guests/{GuestId}/memberships/{UserMembershipId}/waive
•Scenario: This API has been enhanced to save the reasons behind the membership fee waiver with the new reason_id parameter.
•Earlier behavior: Didn’t include the reasons for the waiver.
•New behavior: Saves reasons for the waiver in ZMA.
•API documentation link:

Membership

•API endpoint: GET {api_url} : {{api_url}}/v1/organizations/settings/{section}
•Scenario: This API has been enhanced to retrieve the reasons behind the membership fee waiver new reason_id parameter.
•Earlier behavior: n/a
•New behavior: Retrieves new reasons added at the membership level settings
•API documentation link:

Guest

•API endpoint: GET {api_url}/v1/guests/{guest_id}/guestpass
•Scenario: This API has been enhanced to retrieve the guest passes sent from and received on a guest’s profile.
•Earlier behavior: n/a
•New behavior: Retrieves data for new expand parameters in the request to get the Used, Received, and Available guest passes
•API documentation link:

Admin

•API endpoint: PUT {api_url}/v1/organizations/settings
•Scenario: This new API has been created to save organization or center settings for the tblorganizationsetting table.
•Earlier behavior: n/a
•New behavior: Saves organization or center settings for the tblorganizationsetting table.
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes/{class_id}
•Scenario: This API has been enhanced to check if a class is archived and return a boolean value.
•Earlier behavior: Couldn’t support archived classes as archival of classes wasn’t supported on the product.
•New behavior: If a class is archived, it returns the value 0 and if it isn’t it returns the value 1.
•API documentation link:

Fitness

•API endpoint: POST {api_url}/api/classes/{class_id}/schedules
•Scenario: This API has been updated to hide archived classes in the schedules list.
•Earlier behavior: Didn’t consider archived classes as archival of classes wasn’t supported on the product.
•New behavior: Hides archived classes from being scheduled.
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been improved to retrieve all details of all classes.
•Earlier behavior: Didn’t consider archived as archival of classes wasn’t supported on the product.
•New behavior: Retrieves the archival status of a class too, along with all other details.
•API documentation link:

Fitness

•API endpoint: POST {api_url}/api/classes/{class_id}
•Scenario: This API has been improved to set the class status as ‘Archived’, and vie versa.
•Earlier behavior: Couldn’t set the status as Archived as archival of classes wasn’t supported on the product.
•New behavior: Can set and reset a class’ status as ‘Archived’
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been improved to retrieve all the details of all classes including their status (Active/Inactive/Archived).
•Earlier behavior: Could only retrieve the statuses Active/Inactive.
•New behavior: Can retrieve and return the details regarding the status ‘Archived’.
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been enhanced to sort all columns on the classes UI page(on Zenot).
•Earlier behavior: Supported sorting for only the Last name column.
•New behavior: Now supports sorting on all columns
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been improved to support search with multiple keywords on the classes UI page(on Zenot).
•Earlier behavior: Could only support search with one keyword at a time.
•New behavior: Supports search with multiple keywords separated by the ‘Enter’ key.
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been improved to get the total number of active sessions for each class.
•Earlier behavior: Couldn't retrieve the number of active sessions
•New behavior: Retrieves and returns the total number of active sessions for each class.
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been improved to get the total number of centers with active unique future sessions for each class.
•Earlier behavior: Couldn't retrieve the active sessions count.
•New behavior: Retrieves and returns the number of active sessions for each center.
•API documentation link:

Fitness

•API endpoint: GET {api_url}/api/classes
•Scenario: This API has been improved to get the latest date of future sessions for each class.
•Earlier behavior: Couldn't retrieve the date of future session.
•New behavior: Retrieves and returns the date of the latest future session for each class.
•API documentation link: