ZenotiHelp

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

  1. Navigate to Settings > Integrations > Apps (Organization).
  2. The system verifies that API access is enabled for your organization.
  3. View the list of existing API applications, if any.

Create a new API application

  1. Click Create New Application.
  2. 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).
  1. 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
  1. Click Generate API Key.
  2. The system creates a unique API key for the application.
  3. 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:

  1. Navigate to Settings > Integrations > Apps (Center).
  2. Select the specific center from the dropdown.
  3. Follow the same steps as organization-level applications.
  4. Center-scoped API keys only access data for that specific center.

Edit an existing API application

  1. From the API applications list, click the application name.
  2. Modify the application settings:
  • Update the name or description
  • Adjust permissions and data access scope
  • Enable or disable the application
  1. Click Save Changes.

Note: Editing permissions takes effect immediately for all API calls using that application's key.

Delete an API application

  1. From the API applications list, click the Delete icon next to the application.
  2. Confirm the deletion when prompted.
  3. 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:

  1. Navigate to Settings > Integrations > API Analytics.
  2. View usage metrics for each API application:
  • Request volume over time
  • Response times and error rates
  • Most frequently used endpoints
  1. Use filters to analyze specific time periods or applications.
  2. 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.