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.
New to iZap? The setup wizard scaffolds a working client (REST, MCP, webhooks, or SSE) into your stack in one command.

​
Resources

​
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