Skip to main content

​
GET /api/v1/clients/

Retrieves the general list of all active clients registered in the WispHub system. Returns a parsed list with essential details of each service and contact information.

​
Response

Returns a BackendResponse containing an array of ClientResponse objects.
​
ok
boolean
required
Indicates if the request was successful
​
type
string
required
Response type (e.g., “success”, “error”)
​
action
string
required
Action identifier: clients_listed
​
data
array
required
Array of client objects
​
message
string
Optional message providing additional context

​
Example Request

curl -X GET "https://api.wisphub.example/api/v1/clients/" \
  -H "Content-Type: application/json"

​
Example Response

{
  "ok": true,
  "type": "success",
  "action": "clients_listed",
  "data": [
    {
      "service_id": 12345,
      "name": "Juan Pérez",
      "document": "1234567890",
      "phone": "+573001234567",
      "address": "Calle 123 #45-67",
      "city": "Bogotá",
      "locality": "Centro",
      "payment_status": "active",
      "zone_id": 5,
      "antenna_ip": "192.168.1.1",
      "cut_off_date": "2026-03-15",
      "outstanding_balance": 0.0,
      "lan_interface": "eth0",
      "internet_plan_name": "Plan 50MB",
      "internet_plan_price": 50000.0,
      "technician_id": 10
    },
    {
      "service_id": 12346,
      "name": "María González",
      "document": "9876543210",
      "phone": "+573009876543",
      "address": "Carrera 45 #12-34",
      "city": "Medellín",
      "locality": "Poblado",
      "payment_status": "active",
      "zone_id": 3,
      "antenna_ip": "192.168.1.2",
      "cut_off_date": "2026-03-20",
      "outstanding_balance": 25000.0,
      "lan_interface": "eth1",
      "internet_plan_name": "Plan 100MB",
      "internet_plan_price": 75000.0,
      "technician_id": 8
    }
  ],
  "message": null
}

​
Error Responses

​
500 Internal Server Error
An error occurred while fetching clients from WispHub
{
  "ok": false,
  "type": "error",
  "action": "error",
  "data": null,
  "message": "Failed to retrieve clients"
}
This endpoint returns all active clients in the system. For searching specific clients, use the Search Clients endpoint.