ZenotiHelp

Use integration APIs

ZTZenoti Docs Team Updated March 7, 2026 2 min readGuide

The integration APIs provide connectivity between Zenoti and third-party platforms, including Shopify for e-commerce, digital forms for treatment documentation, and ZenScribe (AI Scribe) for consent management.

For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.

Before you begin

  • You need a valid API key or access token. See Set up API authentication.
  • Integration-specific configuration may be required in Zenoti before using these endpoints.

Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.

Shopify integration

Generate Shopify Multipass URL

GET /v1/ecommerce/shopify/multipass-url

Generates a Shopify Multipass token and returns a URL for redirecting guests after Shopify authentication. This enables single sign-on (SSO) between Zenoti and Shopify.

Parameter Type Required Description
user_id string Yes Guest or user identifier in Zenoti
return_url string Yes URL to redirect to after Shopify authentication

Response: multipass_url (string) -- The generated Shopify Multipass URL for SSO redirect.

Digital forms

Retrieve a guest form

GET /v1/guests/{guest_id}/forms?version_no={version_no}

Retrieves form data for a specific guest.

Parameter Type Required Description
guest_id string Yes Guest identifier
version_no integer Yes Form version number

Response: data (JSON string with form data), guest_data (JSON string with guest info), is_form_submitted (boolean).

Note: Uploaded files, signatures, and annotations are not supported through the API.

Retrieve appointment form data

GET /v1/appointments/{appointment_id}/forms_data

Retrieves form data associated with a specific appointment.

Parameter Type Required Description
appointment_id string Yes Appointment identifier
tag_Id string Yes Form tag identifier
view_context string Yes Context for viewing form data
version_no string Yes Form version number

Response: data (service form details), guest_data (guest details), is_form_submitted.

Retrieve compliance statistics

GET /v1/organizations/treatment_forms/compliance_rule_statistics

Retrieves compliance statistics for treatment form submission and review across the organization.

Parameter Type Required Description
centers list No Filter by center IDs
jobs list No Filter by job IDs
employee_ids list No Filter by provider IDs
start_date datetime No Start date
end_date datetime No End date
page integer Yes Page number
limit integer Yes Records per page

Response: compliance_rule_statistics (array with compliance_rule_id, center_name, target_percentage, total_forms, submitted_forms, submission_percentage, reviewed_forms, review_percentage, is_compliant, and per-employee statistics).

GET /v1/zenscribe/consents

Retrieves guest consent information for ZenScribe.

Response: consent with guest_name, signature, created_date, created_by_name.

POST /v1/zenscribe/consents

Adds guest consent for ZenScribe.

Parameter Type Required Description
owner_id guid Yes Owner identifier
owner_type integer Yes 0=None, 1=Appointment, 2=Guest, 3=Service
signature string Yes Guest signature
guest_id guid Yes Guest identifier

API reference

Was this article helpful?
Your feedback helps us improve our documentation.