Get started with Zenoti APIs
The Zenoti API platform lets you integrate external applications with your Zenoti organization using REST APIs. This article walks you through the prerequisites, initial setup steps, and key concepts you need to start making API calls.
On this page
- What the API platform provides
- Before you begin
- Recommended setup order
- Key concepts
- Common integration scenarios
- Related articles
What the API platform provides
The Zenoti API platform gives you programmatic access to core Zenoti features:
- Retrieve center, service, product, and membership data
- Create and manage guest profiles and appointments
- Process invoices and collect payments
- Track sales leads through the opportunities pipeline
- Receive real-time event notifications through webhooks
- Generate reports for business analytics
Before you begin
Before making your first API call, ensure the following:
- Zenoti organization access -- You need administrator-level access to your Zenoti organization.
- Security role permissions -- Your security role must include the following permissions:
- Navigate to Configuration > Security > Security roles.
- Select your role and open Permissions.
- Expand Administrator settings.
- Enable Manage API Keys, Manage Apps, and Manage Automation.
- Save the configuration.
- API base URL -- All API requests use the base URL
https://api.zenoti.com.
Recommended setup order
Follow these steps to set up your API integration:
Step 1: Create a backend application and generate an API key
Create a backend application in Zenoti to get your application credentials. Each backend application receives an App ID, App Secret, and API Key.
Tip: Create individual applications for individual use cases. A generic application with global permissions to all modules can lead to issues in debugging errors and pose a security threat.
For detailed instructions, see Set up API authentication.
Step 2: Configure authorization
Set up API group permissions for your backend application. Authorization controls which API endpoints your application can access, independent of the user's security role permissions.
For details, see Set up API authorization.
Step 3: Choose your authentication method
Decide between API key authentication and token-based authentication:
| Method | Best for | Expiration |
|---|---|---|
| API key | Server-to-server integrations accessing organization-wide data | Valid for one year before renewal |
| Access token | Client-side applications needing role-based access | Expires after 10 hours (use refresh tokens) |
Step 4: Make your first API call
Test your setup by retrieving a list of centers:
GET /v1/centers
Include your authentication header:
- API key:
Authorization: apikey {{api_key}} - Access token:
Authorization: bearer {{access_token}}
A successful response returns a JSON object with a centers array and page_info object.
Step 5: Implement pagination and error handling
- Configure pagination for list endpoints. See Configure API pagination.
- Set up error handling for API responses. See Configure API error handling.
Step 6: Set up webhooks (optional)
If your integration needs real-time event notifications, configure webhooks. See Set up webhook integration.
Key concepts
| Concept | Description |
|---|---|
| REST API | Zenoti uses standard HTTP methods -- GET for retrieval, POST for creation and actions, PUT for updates, DELETE for removal |
| JSON format | All requests and responses use JSON |
| API key | A long-lived credential for server-to-server authentication (valid one year) |
| Access token | A short-lived credential for role-based authentication (expires after 10 hours) |
| Refresh token | Used to obtain a new access token without re-authenticating |
| Backend application | A registered application in Zenoti that receives an App ID, App Secret, and API Key |
| API groups | Permission groups that control which API endpoints a backend application can access |
| Rate limit | Maximum of 60 API calls per minute per organization |
| Pagination | List endpoints return paginated results with a maximum of 100 records per page |
| Custom sources | Booking origins (Webstore, Consumer Mobile App, Client App, Bot) that tag appointments with their source |
Common integration scenarios
Online booking platform -- Use the service booking workflow to let guests book appointments from your website or app. This involves retrieving services, checking available slots, creating bookings, and processing payments.
CRM synchronization -- Use guest APIs to keep guest profiles synchronized between Zenoti and your CRM. Set up webhooks for Guest Created and Guest Updated events for real-time sync.
Reporting dashboard -- Use report APIs and invoice webhooks to build custom analytics dashboards that pull data from Zenoti.
Membership portal -- Use membership and guest APIs to build a self-service portal where members can view their benefits, check loyalty points, and manage their subscriptions.