GET /admin/api-keys/{id}/devices/status

Live connection status for all devices under a specific API key

Path parameters

  • id integer Required

    API Key ID

Responses

  • 200 application/json

    Device statuses retrieved

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data array[object]
      Hide data attributes Show data attributes object
      • device_id string
      • device_name string
      • whatsmeow_jid string
      • db_status string
      • client_loaded boolean
      • connected boolean

        Legacy flag: true only when fully connected

      • is_connected boolean
      • is_logged_in boolean
      • error string
  • 404

    API key not found

GET /admin/api-keys/{id}/devices/status
curl \
 --request GET 'http://localhost:7001/admin/api-keys/{id}/devices/status' \
 --header "X-Admin-Secret: $API_KEY"
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Device statuses retrieved successfully",
  "data": [
    {
      "device_id": "550e8400-e29b-41d4-a716-446655440000",
      "device_name": "Production Phone",
      "whatsmeow_jid": "6281234567890@s.whatsapp.net",
      "db_status": "active",
      "client_loaded": true,
      "connected": true,
      "is_connected": true,
      "is_logged_in": true,
      "error": "string"
    }
  ]
}