GET /api/v1/clients/by-service-id/
Retrieves client information using their WispHub service ID. This is the most precise search method as it uses the system’s unique identifier.
Path Parameters
The client’s unique WispHub service identifier. This is the most reliable way to retrieve a specific client’s information.
Response
Returns a BackendResponse containing a single ClientResponse object.
Indicates if the request was successful
Response type (e.g., “success”, “error”)
Action identifier: client_found or client_not_found
Client information objectShow ClientResponse properties
Unique service identifier in WispHub
Client’s identity document (cédula)
Client’s physical address
Client’s locality or neighborhood
IP address of the assigned antenna
Outstanding balance amount
Name of the internet plan
Price of the internet plan
Assigned technician identifier
Optional message providing additional context
Example Request
curl -X GET "https://api.wisphub.example/api/v1/clients/by-service-id/12345" \
-H "Content-Type: application/json"
Example Response
{
"ok": true,
"type": "success",
"action": "client_found",
"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
},
"message": null
}
Error Responses
No client found with the provided service ID{
"ok": false,
"type": "error",
"action": "client_not_found",
"data": null,
"message": "Client not found"
}
This is the most precise method to retrieve client information. If you have the service_id, use this endpoint for guaranteed accurate results.
