API ReferenceIntake Bots
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Pass your ioZen API key as a Bearer token in the Authorization header.
In: header
Path Parameters
id*string
Intake bot ID
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://app.iozen.ai/api/v1/intake-bots/cm7abc12x0001yz9k8mno3pqr"{
"success": true,
"data": {
"intake_bot": {
"id": "cm7abc12x0001yz9k8mno3pqr",
"name": "Customer Onboarding",
"status": "ACTIVE",
"description": "Collects new customer information for onboarding",
"share_url": "cust-onboard-x7k2",
"submission_count": 142,
"schema": [
{
"name": "full_name",
"label": "Full Name",
"type": "text",
"required": true
},
{
"name": "email",
"label": "Email",
"type": "email",
"required": true
},
{
"name": "company",
"label": "Company",
"type": "text",
"required": false
},
{
"name": "priority",
"label": "Priority",
"type": "select",
"options": [
"low",
"medium",
"high"
]
}
],
"created_at": "2026-01-15T10:30:00.000Z",
"updated_at": "2026-02-20T14:22:00.000Z"
}
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "Validation failed",
"details": {}
}
}{
"success": false,
"error": {
"code": "authentication_required",
"message": "Missing or invalid API key",
"details": {}
}
}{
"success": false,
"error": {
"code": "insufficient_scopes",
"message": "API key lacks required scopes for this endpoint",
"details": {}
}
}{
"success": false,
"error": {
"code": "resource_not_found",
"message": "Resource not found",
"details": {}
}
}{
"success": false,
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded",
"details": {}
}
}{
"success": false,
"error": {
"code": "internal_error",
"message": "An internal error occurred",
"details": {}
}
}