API applications
ZTZenoti Docs Team Updated March 21, 2026 2 min readGuide
Manage API applications that allow external systems to integrate with your Zenoti organization through secure API keys and permissions.
Before you begin
- You need organization administrator access.
- Your organization must have API access enabled in organization settings.
- You need the following permissions:
Permission: Export Operations (under Export_Admin) β Required to view and export integration data.
Steps
Access API application management
- Navigate to Settings > Integrations > Apps (Organization).
- The system verifies that API access is enabled for your organization.
- View the list of existing API applications, if any.
Create a new API application
- Click Create New Application.
- Configure the following settings:
- Application Name β Enter a descriptive name for the external system or integration.
- Description β Add details about the application's purpose (optional).
- Select the appropriate permissions for this application:
- Choose specific API endpoints the application can access
- Set read-only or read-write permissions as needed
- Configure data scope limitations
- Click Generate API Key.
- The system creates a unique API key for the application.
- Copy the API key immediately and store it securely β it will not be displayed again.
Configure center-level API applications
If your organization has center-level API access enabled:
- Navigate to Settings > Integrations > Apps (Center).
- Select the specific center from the dropdown.
- Follow the same steps as organization-level applications.
- Center-scoped API keys only access data for that specific center.
Edit an existing API application
- From the API applications list, click the application name.
- Modify the application settings:
- Update the name or description
- Adjust permissions and data access scope
- Enable or disable the application
- Click Save Changes.
Note: Editing permissions takes effect immediately for all API calls using that application's key.
Delete an API application
- From the API applications list, click the Delete icon next to the application.
- Confirm the deletion when prompted.
- The API key becomes invalid immediately.
Important: External systems using the deleted API key will receive authentication errors. Update those systems before deleting the application.
Monitor API usage
If API analytics are enabled for your organization:
- Navigate to Settings > Integrations > API Analytics.
- View usage metrics for each API application:
- Request volume over time
- Response times and error rates
- Most frequently used endpoints
- Use filters to analyze specific time periods or applications.
- Export analytics data for further analysis if needed.
Tips
- Use descriptive application names that identify the external system (e.g., "Shopify Integration", "Custom Mobile App").
- Apply the principle of least privilege β grant only the minimum permissions required for each integration.
- Regularly review and audit API applications to remove unused or outdated integrations.
- Store API keys securely in your external systems using environment variables or secure configuration management.
- Test API applications in a development environment before deploying to production.
Was this article helpful?
Your feedback helps us improve our documentation.