Skip to main content
The iZap REST API is rooted at /api/v1 on each environment and authenticated with OAuth 2.0 / JWT (see Authentication). Browse the full request and response schema — and try calls live — in the Endpoints section of this tab.
EnvironmentOrigin
Productionhttps://api.izap.ai
Staginghttps://api-staging.izap.ai
New to iZap? The setup wizard scaffolds a working client (REST, MCP, webhooks, or SSE) into your stack in one command.

Resources

ResourcePathPurpose
Auth/api/v1/auth/*, /oauth/*JWT login and OAuth 2.0
Businesses/api/v1/businesses/*Tenant config and members
Chats/api/v1/chats/*Conversation read/write and sending
Scheduling/api/v1/scheduling/*Customers, services, and bookings
WhatsApp templates/api/v1/whatsapp_templates/*Manage and sync message templates
Transmissions/api/v1/transmissions/*WhatsApp broadcasts

Conventions

  • Versioning — the API is mounted under /api/v1; breaking changes move to a new version path.
  • Auth — send Authorization: Bearer <jwt> on every request.
  • Content type — JSON request and response bodies, except form-encoded auth.

Status

Check live platform health on the status page. The /health endpoint stays available as a machine-readable JSON liveness probe for your own monitoring.

Error model

StatusMeaning
401Missing/expired token — re-authenticate.
422Validation error — check the request body.
400Domain or data conflict.
500Server error.