REST API - iZap Developers

The iZap REST API is rooted at /api/v1 on each environment and authenticated with a personal access token or OAuth 2.0 (see Authentication). Browse the full request and response schema — and try calls live — in the Endpoints section of this tab.

Environment	Origin
Production	`https://api.izap.ai`
Staging	`https://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

Resource	Path	Purpose
Auth	`/oauth/*`	OAuth 2.0 for third-party apps; see Authentication
API tokens	`/api/v1/me/api-tokens/*`	Create, list, and revoke personal access tokens
Businesses	`/api/v1/businesses/*`	Tenant config, hours, menus, and library assets
Chats	`/api/v1/chats/*`	Conversation read/write and sending
WhatsApp templates	`/api/v1/whatsapp_templates/*`	Manage and sync message templates
Transmissions	`/api/v1/transmissions/*`	WhatsApp broadcasts
Webhooks	`/api/v1/webhook-endpoints/*`	Register a URL to receive events, see Webhooks

Conventions

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

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

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