API Change Log - 17 Feb 2026 - DRAFT

Reports-Core V2

• API Endpoint: {api_url} /v1/reports/collections/flat_file

• Scenario: This API retrieves the collections details in the organization during selected date range.

• API method: POST

• Earlier behavior: The collections report response excluded card surcharge tax details, reporting only base tax, tips, SSG, ESF, and other existing totals.

• New behavior: The collections report response includes tax_on_surcharge and total_tax_including_surcharge, enabling accurate reporting of payment surcharge taxes.

Reports-Core V2

• API Endpoint: {api_url} /v1/reports/aveda_benchmark_summary

• Scenario: This API retrieves the details for Aveda benchmark report.

• API method: POST

• Earlier behavior: The API returned guest service KPIs without distinguishing between appointments booked with requests and without requests.

• New behavior: The API returns separate guest KPIs for with-request and without-request services, and includes the RetailPerRetailTransaction metric.

Webstore V1, Webstore V2

• API Endpoint: {{baseUrl}}/v1/giftcards/templates/custom

• Scenario: This API creates a custom package template for gift cards based on the selected services and the provided criteria, including support for member pricing. If the member pricing option is enabled and the guest has an active membership, the template should be generated using the member-specific pricing.

• API method: POST

• Earlier behavior: The create template API did not apply member pricing for services, even when the guest had an active membership.

• New behavior: The create template API applies member pricing for services when the guest has an active membership.

Loyalty

• API Endpoint: {api_url}/v1/guests/aveda_membership?search_value={membership_or_email}

• Scenario: This API checks if a guest can be linked to an Aveda membership, by validating a provided membership ID or email address. It returns either a membership ID (on success) or an error code (on failure).

• API method: GET

• Earlier behavior: New API. No earlier behavior.

• New behavior: The API validates an Aveda membership ID or email, returning a linkable membership ID or error code.

AI Scribe

• API Endpoint: v1/zenscribe/employee_associations/list

• Scenario: This API fetches the employee associations for the AI scribe license-based feature.

• API method: POST

• Earlier behavior: New API. No earlier behavior.

• New behavior: The API returns employee association records filtered by centers, jobs, view status, search text, and paging.

Digital Forms V3, Medical Record

• API Endpoint: POST {base_url}/v1/emr/migrations/ai_mappings

• Scenario: This API endpoint receives AI-generated field mappings from an external Lambda service after AI processing of EMR (Electronic Medical Records) form fields.

• API method: POST

• Earlier behavior: New API. No earlier behavior.

• New behavior: The API accepts Lambda-generated mappings, validates custom header and HMAC signature, resolves entities, saves mappings, and notifies clients via SignalR.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}

• Scenario: This API deletes the organization level membership cancellation template.

• API method: DELETE

• Earlier behavior: New API. No earlier behavior.

• New behavior: The API deletes the specified membership cancellation template at the organization level and returns error details when it fails.

Digital Forms V3, Medical Record

• API Endpoint: POST {base_url}/v1/emr/migrations/ai_mappings

• Scenario: This API receives AI-generated EMR field mappings from Lambda, validates them, saves resolved mappings, and updates the UI in real time.

• API method: POST

• Earlier behavior: New API. No earlier behavior.

• New behavior: The API validates the custom header and HMAC signature, resolves entities, saves mappings, and pushes updates via SignalR.

Employee

• API Endpoint: {api_url}/v1/biometric/encryption_details

• Scenario: This API returns encryption keys required for secure client-side biometric data encryption and decryption in the biometric app.

• API method: GET

• Earlier behavior: New API. No earlier behavior.

• New behavior: The API securely returns biometric encryption keys to authorized biometric app contexts, enforcing feature and permission checks.

Fitness Core

• API Endpoint: {{api_url}}/v1/classes/instructors/sessions

• Scenario: This API retrieves the list of all class sessions.

• API method: GET

• Earlier behavior: Training schedules and instructor sessions loaded slowly, impacting roster, webstore, and class-related flows.

• New behavior: Training schedules load faster through optimized stored procedures, without changing booking, membership, or fee outcomes.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}/buyout_rules/{rule_id}"

• Scenario: This API updates an existing buyout fee rule on an organization’s membership cancellation template.

• API method: PUT

• Earlier behavior: New API. No earlier behavior.

• New behavior: You can update a specific buyout rule by template_id and rule_id, with validation for lock-type consistency and overlap.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}/buyout_rules/{rule_id}

• Scenario: This API deletes an existing buyout fee rule on an organization’s membership cancellation template.

• API method: DELETE

• Earlier behavior: New API. No earlier behavior.

• New behavior: You can delete a buyout rule by template_id and rule_id, returning error null on success.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}/buyout_rules

• Scenario: This API fetches all buyout fee rules configured for a specific organization-level membership cancellation template.

• API method: GET

• Earlier behavior: New API. No earlier behavior.

• New behavior: You can retrieve the template’s buyout rules with template_id, returning the rules list or an error.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}/buyout_rules

• Scenario: This API creates a new buyout fee rule for an organization-level membership cancellation template using template_id and rule details.

• API method: POST

• Earlier behavior: New API. No earlier behavior.

• New behavior: Clients can POST a buyout rule for a template and receive the new buyout_rule_id or an error response.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}

• Scenario: This API updates an existing organization-level membership cancellation template’s details, refund settings, and termination rules.

• API method: PUT

• Earlier behavior: New API. No earlier behavior.

• New behavior: Clients can PUT updated template fields for a given template_id and receive the updated template_id or an error.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates

• Scenario: This API creates a new organization-level membership cancellation template with refund and termination rule settings.

• API method: POST

• Earlier behavior: New API. No earlier behavior.

• New behavior: Clients can POST template details to create a new template and receive the created template_id or an error.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates/{template_id}

• Scenario: This API fetches details of one organization-level membership cancellation template using its template_id.

• API method: GET

• Earlier behavior: New API. No earlier behavior.

• New behavior: Clients can GET the template by template_id and receive the full template object or a not-found error.

Memberships

• API Endpoint: {api_url}/v1/organizations/settings/membership_cancel_templates

• Scenario: This API retrieves a paginated list of organization-level membership cancellation templates for admin management and selection.

• API method: GET

• Earlier behavior: New API. No earlier behavior.

• New behavior: Clients can GET templates with page and size, and receive the template list plus pagination metadata.