Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knoxcall.com/llms.txt

Use this file to discover all available pages before exploring further.

Get Client

GET /v1/clients/:id
Returns a single client with its route assignments.

Path Parameters

ParameterTypeDescription
iduuidThe client ID

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",
    "route_assignments": [
      {
        "route_id": "rt-uuid-1",
        "route_name": "Payment Gateway",
        "environment_name": "production"
      },
      {
        "route_id": "rt-uuid-2",
        "route_name": "User Service",
        "environment_name": "production"
      }
    ]
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}

Errors

StatusTypeDescription
404not_foundClient not found