Skip to main content

​
List Clients

GET /v1/clients
Returns a paginated list of all clients in your tenant.

​
Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger20Items per page (max 100)
sortstringcreated_atSort by: created_at, name, type, or ip_address
orderstringdescSort direction: asc or desc
typestring—Filter by client type: user or server

​
Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Production Backend",
      "type": "server",
      "ip_address": "203.0.113.0/24",
      "ip_notes": {},
      "description": "Main backend servers",
      "enabled": true,
      "collection_id": null,
      "created_at": "2026-01-15T09:30:00.000Z",
      "updated_at": "2026-02-20T11:00:00.000Z"
    }
  ],
  "meta": {
    "total": 8,
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curl "https://api.knoxcall.com/v1/clients?type=server" \
  -H "Authorization: Bearer tk_live_abc123..."

import requests

resp = requests.get(
    "https://api.knoxcall.com/v1/clients",
    params={"type": "server"},
    headers={"Authorization": "Bearer tk_live_abc123..."}
)
clients = resp.json()["data"]

const resp = await fetch("https://api.knoxcall.com/v1/clients?type=server", {
  headers: { Authorization: "Bearer tk_live_abc123..." }
});
const { data: clients } = await resp.json();