List Clients - KnoxCall Docs

List Clients

GET /v1/clients

Returns a paginated list of all clients in your tenant.

Query Parameters

Parameter	Type	Default	Description
`page`	integer	`1`	Page number
`per_page`	integer	`20`	Items per page (max 100)
`sort`	string	`created_at`	Sort by: `created_at`, `name`, `type`, or `ip_address`
`order`	string	`desc`	Sort direction: `asc` or `desc`
`type`	string	—	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"
  }
}

import { KnoxCall } from "@knoxcall/sdk";

const client = new KnoxCall(); // credentials from `knoxcall login` or KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET

const page = await client.clients.list({ page: 1, per_page: 20 });
const clients = page.data;

from knoxcall import KnoxCall

client = KnoxCall()  # credentials from `knoxcall login` or KNOXCALL_CLIENT_ID / KNOXCALL_CLIENT_SECRET

page = client.clients.list(page=1, per_page=20)
clients = page["data"]

# Mint a 1-hour OAuth token (client_credentials) — see /api-reference/authentication
TOKEN=$(curl -s -X POST https://api.knoxcall.com/oauth/token \
  -u "$KNOXCALL_CLIENT_ID:$KNOXCALL_CLIENT_SECRET" \
  -d "grant_type=client_credentials" | jq -r .access_token)

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