WhatsApp API Platform
Chatbots

List chatbots

POST
/api/v1/chatbots

List chatbots for your account with optional filters and pagination. Filters are passed in the request body.

Authorization

ApiKeyAuth
X-API-Key<token>

API key from your dashboard (Settings > API Keys)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/chatbots" \  -H "Content-Type: application/json" \  -d '{    "page": 0,    "limit": 20,    "search": "support",    "status": [      "ACTIVE"    ]  }'
{
  "success": true,
  "data": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "data": [
      {
        "id": "cbt_abc123",
        "user_id": "string",
        "name": "string",
        "description": "string",
        "status": "DRAFT",
        "trigger_type": "MESSAGE_CONTAINS",
        "trigger_config": {},
        "start_node_id": "string",
        "active_version_id": "string",
        "variables": [
          {
            "id": "string",
            "name": "string",
            "type": "string",
            "default_value": null,
            "description": "string",
            "is_required": true
          }
        ],
        "settings": {
          "session_timeout_minutes": 0,
          "fallback_message": "string",
          "max_retries": 0,
          "handoff_enabled": true,
          "handoff_team_id": "string"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "node_count": 0
      }
    ]
  }
}
{
  "success": false,
  "message": "to field is required"
}
{
  "success": false,
  "message": "user not authenticated"
}
{
  "success": false,
  "message": "forbidden"
}
{
  "success": false,
  "message": "internal server error"
}

Get chatbot GET

Get a single chatbot by ID. The response includes the chatbot's `nodes` and `links` arrays (its flow graph) for inspection — flow editing is done from the dashboard builder.

Update chatbot PUT

Update a chatbot's metadata, trigger, variables, settings, or status. All fields are optional — only the provided fields are changed.