List Clients

Endpoint

GET /api/v1/clients

Authentication

Header	Required
x-api-key	Yes

Use a partner-scoped API key. Platform-wide keys without a partner_id receive 403 API_KEY_SCOPE_FORBIDDEN.

No x-clive-hmac or idempotency-key is required on this read endpoint.

Success response

200 OK

Clients are returned in descending created_at order (newest first).

{
  "items": [
    {
      "id": "cm8s6abc123",
      "partner_id": "ECHEZONA001",
      "client_id": "AIRPEACE001",
      "legal_name": "Air Peace Ltd",
      "status": "active",
      "partner_fee_percentage": null,
      "partner_fee_flat_usd": null,
      "created_at": "2026-03-05T15:21:35.222Z",
      "updated_at": "2026-03-05T15:21:35.222Z"
    }
  ]
}

Error responses

HTTP	Code	Meaning
401	API_KEY_INVALID	Invalid or missing API key
403	API_KEY_SCOPE_FORBIDDEN	Key not scoped to a partner
403	PARTNER_SUSPENDED	Partner is suspended
404	PARTNER_NOT_FOUND	Partner no longer exists

Notes

• Designed for dashboards, onboarding checks, and reconciliation.
• To create clients via API, use Create Client.

cURL example

curl -X GET "$CLIVE_API_BASE_URL/clients" \
  -H "x-api-key: $CLIVE_API_KEY"