ioZen Developer Documentation

Welcome to the ioZen API documentation. Here you'll find everything you need to integrate with ioZen programmatically.

Quick Links

• Getting Started — Create your first API key and make your first request
• Authentication — API key authentication, scopes, and rate limits
• API Reference — Full endpoint reference with request/response schemas
• Webhooks — Receive real-time event notifications
• Error Handling — Error codes, HTTP statuses, and troubleshooting

Overview

The ioZen API is a RESTful JSON API that enables you to:

• Read intake bots — List your intake bots, check their status, and retrieve configuration
• Create and retrieve submissions — Submit data programmatically and read submission results
• Manage webhooks — Register endpoints to receive real-time notifications when events occur
• Integrate with automation tools — Connect ioZen to Zapier, Make, n8n, and custom workflows

All API endpoints are available at:

https://app.iozen.ai/api/v1/

Quick Example

curl https://app.iozen.ai/api/v1/intake-bots \
  -H "Authorization: Bearer iozen_live_your_api_key_here"

{
  "success": true,
  "data": {
    "intake_bots": [
      {
        "id": "clxyz...",
        "name": "Contact Intake",
        "status": "ACTIVE",
        "submission_count": 42,
        "created_at": "2026-02-23T10:00:00.000Z",
        "updated_at": "2026-02-23T12:00:00.000Z"
      }
    ],
    "pagination": {
      "has_more": false,
      "next_cursor": null
    }
  }
}

Authentication

Every request must include a valid API key in the Authorization header:

Authorization: Bearer iozen_live_your_api_key_here

API keys are available on Pro and Business plans. Create one from Workspace Settings → API Keys. See the Authentication guide for details on scopes and rate limits.

Need Help?

• Email us at hello@iozen.ai
• Include the X-Request-Id header value from the response when reporting issues
• Check the Error Reference for troubleshooting common issues