API Change Log – 18 Feb 2025

Photo Manager

• API Endpoint: {api_url}/v1/photo_management/global_gallery/files/grouped_data/flat_file
• Scenario: This API gets the guests and files for global gallery.
• API method: POST
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API gets the guests and files for global gallery.

Photo Manager

• API Endpoint: {api_url}/v1/photo_management/global_gallery/files/flat_file
• Scenario: This API gets patient files according to the filter criteria.
• API method: POST
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API gets patient files according to the filter criteria.

Fitness

• API Endpoint: {api_url}/v1/guests/{guest_id}/memberships/{user_membership_id}/members?expand=is_checked_in&expand=profile_image_url
• Scenario: This API adds the profile_image_url and is_checked_in the response object to get the profile_image_url and is_checked_in for the primary member and all the add on members.
• API method: GET
• Earlier behavior: Old API response only had only user_id and guest name in the response.
• New behavior: This API has added new response parameters in the add on members response.

Photo Manager

• API Endpoint: {api_url}/v1/photo_management/global_gallery/files
• Scenario: This API deletes the list of files from global gallery.
• API method: DELETE
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API deletes the list of files from global gallery.

Photo Manager

• API Endpoint: {api_url}/v1/photo_management/global_gallery/files/{file_id}
• Scenario: This API updates metadata of the given file in global gallery.
• API method: PUT
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API updates metadata of the given file in global gallery.

Photo Manager

• API Endpoint: {api_url}/v1/photo_management/global_gallery/filters
• Scenario: This API fetches the filter criteria of global gallery.
• API method: GET
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API fetches the filter criteria of global gallery.

Photo Manager

• API Endpoint: {api_url}/v1/photo_management/global_gallery/import?source=<Patient_Gallery_Enum>
• Scenario: This API exports patient files to global gallery from patient gallery.
• API method: PUT
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API exports patient files to global gallery from patient gallery.

Fitness

• API Endpoint: {api_url}/v1/classes/challenge_metrics
• Scenario: This API gets all available challenge details for classes in organization level.
• API method: GET
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API gets all available challenge details for classes in organization level.

Fitness

• API Endpoint: v1/appointments/{appointment_id}/progress
• Scenario: This API gets all available challenge details for classes in organization level.
• API method: GET
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API gets all available challenge details for classes in organization level.

Webstore

• API Endpoint: {api_url}/v1/guests
• Scenario: This API helps in creating a guest.
• API method: POST
• Earlier behavior: This API used to help in creating new guests.
• New behavior: This API helps honor referral codes.

Fitness

• API Endpoint: {api_url}/v1/organizations/age_price_templates
• Scenario: This API lists all available details including employees, centers, classes, etc.
• API method: POST
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API lists all available details including employees, centers, classes, etc.

Fitness

• API Endpoint: {api_url}/v1/organizations/age_price_templates
• Scenario: This API allows to create age price templates for classes in the organization level.
• API method: POST
• Earlier behavior:
• New behavior:

Fitness

• API Endpoint: {api_url}/v1/classes/challenges
• Scenario: This API allows to create challenges for classes in the organization level.
• API method: POST
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API allows to create challenges for classes in the organization level.

Fitness

• API Endpoint: {api_url}/v1/classes/challenges/{challenge_id}
• Scenario: This API allows to update class challenge in organization level.
• API method: PUT
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API allows to update class challenge in organization level.

Fitness

• API Endpoint: {api_url}/v1/classes/challenges/{challenge_id}
• Scenario: This API allows to delete challenges for classes in the organization level.
• API method: DELETE
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API allows to delete challenges for classes in the organization level.

Fitness

• API Endpoint: {api_url}/v1/classes/challenges
• Scenario: This API allows to get all available challenge details for classes in the organization level.
• API method: GET
• Earlier behavior: New API. No earlier behavior
• New behavior: This API allows to get all available challenge details for classes in the organization level.

Fitness

• API Endpoint: {api_url}/v1/guests/{guest_id}/guest_challenges
• Scenario: This API allows to set a challenge to guests.
• API method: PUT
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API allows to set a challenge to guests.

Fitness

• API Endpoint: {api_url}/v1/guests/{guest_id}/guest_challenges
• Scenario: This API shows details of guest challenges.
• API method: GET
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API shows details of guest challenges.

Fitness

• API Endpoint: {api_url}/v1/guests/{guest_id}/guest_challenges/{guest_challenge_id}
• Scenario: This API allows to delete challenges accepted by guests.
• API method: DELETE
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API allows to delete challenges accepted by guests.

API V1, Webstore V2

• API Endpoint: {api_url} /v1/Centers
• Scenario: This API provides list of centers based on params.
• API method: DELETE
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API allows to delete challenges accepted by guests.

API V1, Webstore V2

• API Endpoint: {api_url} /v1/Centers/{center_id}/services"
• Scenario: This API provides the service associated with the requested center based on params.
• API method: GET
• Earlier behavior: This API fetched all services in a center.
• New behavior: This API also fetches campaign and introductory pricing.

Admin

• API Endpoint: {{api_url}}/v1/organizations/service/categories
• Scenario: This API provides the service associated with the requested center based on params.
• API method: GET
• Earlier behavior: This API had permissions for Services (Add/Edit) and Guest Engagement report (Feedback report/Forms report).
• New behavior: This API now includes permissions for Appointments (Add/Edit/ReadOnly) and access to the appointment web.

Invoice

• API Endpoint: {api_url} /v1/invoices/{invoice_id}
• Scenario: This API enhances the v1 retrieve invoice details API to include GST sequence and redemption details.
• API method: GET
• Earlier behavior: This API did not include GST and redemptions.
• New behavior: This API includes GST and redemptions.

Appointment

• API Endpoint: {api_url}/v1/invoices/{invoice_id}/confirm?undo_confirm=true
• Scenario: This API confirms appointment visit. Appointment visit confirmation can also be undone using this API.
• API method: PUT
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API confirms appointment visit. Appointment visit confirmation can also be undone using this API.

Appointment

• API Endpoint: v1/appointments/{appointment_id}/progress
• Scenario: This API marks the status of an appointment as start, open, or complete.
• API method: PUT
• Earlier behavior: New API. No earlier behavior.
• New behavior: This API marks the status of an appointment as start, open, or complete.

Appointment

• API Endpoint: {api_url}/v1/bookings/{{id}}/slots/reserve
• Scenario: This API supports invoice creation at the reservation stage.
• API method: POST
• Earlier behavior: At the reservation stage, invoice_id,appointment_id, and invoice_item_id was null in the invoice.
• New behavior: Now, invoice_id,appointment_id, and invoice_item_id will have values in the response.

API V1

• API Endpoint: {api_url} /v1/guests/{guest_Id}/campaigns/list
• Scenario: This API gets the campaigns which are applicable to users.
• API method: GET
• Earlier behavior: New API. No earlier behavior.
• New behavior: It fetches campaigns which are applicable to users.