Get intake bot — ioZen Docs

GET

/intake-bots/{id}

GET

/intake-bots/{id}

Authorization

bearerAuth

headerAuthorizationBearer <token>

API key authentication. Pass your ioZen API key as a Bearer token in the Authorization header.

Path Parameters

id*string

Intake bot ID

Response Body

Successful response

application/json

response

success*true

Value intrue

data*

Example Request

curl -X GET 'https://app.iozen.ai/api/v1/intake-bots/cm7abc12x0001yz9k8mno3pqr'

Example Request

curl -X GET 'https://app.iozen.ai/api/v1/intake-bots/cm7abc12x0001yz9k8mno3pqr'

Example ResponseSchema

{
  "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": 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"    }  }}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body