Use report APIs
The report APIs let you retrieve operational and financial reports from Zenoti, including sales data, appointment lists, collections, and employee activity audits. Use these APIs to build custom dashboards, export data for analytics, or synchronize reporting data with external systems.
For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.
On this page
- Before you begin
- Sales reports
- Appointment reports
- Collections reports
- Employee audit reports
- Tips
- Related articles
Before you begin
- You need a valid API key or access token. See Set up API authentication.
- Most report endpoints have a maximum date range of 7 days per request. For longer periods, make multiple requests with sequential date ranges.
Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.
Sales reports
Sales accrual report
POST /v1/reports/sales/accrual_basis/flat_file
Retrieves sales data for a center or organization for accrual-based accounting. This is the current recommended endpoint for sales reporting.
| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | datetime | Yes | Report period start |
| end_date | datetime | Yes | Report period end |
| guest_ids | list | No | Filter by specific guests |
| sold_by_ids | list | No | Filter by sales staff |
| item_types | list | No | Filter by item categories (services, products, etc.) |
| item_ids | list | No | Filter by specific items |
| category_ids | list | No | Filter by product or service categories |
| invoice_statuses | list | No | Filter by invoice status |
| business_units | object | No | Filter by business units |
| group_columns | list | No | Columns to group results by |
Response: Sales records with sale_date, invoice_no, receipt_no, guest_name, center_name, item_name, item_type, qty, sales_exc_tax, sales_inc_tax, tax, discount, payment_type, provider, sold_by, closed_by. Includes page_info for pagination.
Sales report (deprecated)
GET /v1/sales/salesreport
Note: This endpoint is deprecated. Data from this endpoint cannot be reconciled with the sales accrual and sales cash reports in the Zenoti UI. Use the sales accrual report endpoint instead.
Appointment reports
Retrieve appointments of a center
GET /v1/appointments
Retrieves all appointments for a center within a date range, including blockout times.
| Parameter | Type | Required | Description |
|---|---|---|---|
| center_id | guid | Yes | Center identifier |
| start_date | datetime | Yes | Start date |
| end_date | datetime | Yes | End date (max 7-day range) |
| include_no_show_cancel | boolean | No | Include no-show and cancelled appointments |
| therapist_id | guid | No | Filter by therapist |
Response: Appointment records with guest details (id, first_name, last_name, email, mobile), appointment details (appointment_id, start_time, end_time, status, progress, invoice_id), service details (name, category, is_addon), therapist details, room, equipment, and notes.
Collections reports
Fetch collections report
POST /v1/reports/collections/flat_file
Retrieves payment collection details for the organization during a date range. This is the current recommended endpoint.
Response: Collection records with payment_date, invoice_no, guest_name, center_name, amount_paid, tax_collected, payment_type, tip, card details (card_type, card_number), check details, and collected_by.
Collections report (deprecated)
GET /v1/centers/{center_id}/collections_report
Note: This endpoint is deprecated. Use the fetch collections report endpoint instead.
Employee audit reports
Fetch employee audit report
POST /v1/reports/audit/employee_activities/flat_file
Retrieves an audit trail of employee activities based on filters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | datetime | No | Report start date |
| end_date | datetime | No | Report end date |
| centers | object | No | Filter by centers |
| employees | object | No | Filter by employees |
| object_type | object | No | Filter by object type (1=Org, 2=Center, 3=Role, 4=Services, 5=Products) |
| page | integer | No | Page number |
| size | integer | No | Records per page |
Response: Audit records with changed_on, employee_name, employee_center_name, object_type, object_name, object_action_name, action_type (Insert or Update), old_value, new_value, updated_by_email.
Tips
- Use the
group_columnsparameter on POST report endpoints to aggregate results by center, employee, item type, or other dimensions. - Report endpoints that accept date ranges typically have a 7-day maximum. For monthly or quarterly reports, iterate through 7-day windows.
- Prefer the POST-based flat file endpoints over deprecated GET endpoints. The POST endpoints support richer filtering and return data consistent with the Zenoti UI.
- Use pagination to retrieve large result sets efficiently.