API Clients Endpoint

Clients API

Base path: /api/v1/clients. Auth scope: clients.read, clients.create, clients.update, clients.delete.

GET /api/v1/clients

List clients. Paginated.

Query params: page (default 1), per_page (default 50, max 100), search (account_number, company_name, email), status (active, inactive, suspended).

Response: {"success":true,"data":[...],"pagination":{"page":1,"per_page":50,"total":150,"total_pages":3}}

GET /api/v1/clients/{id}

Get client by ID or UUID. Includes user object (email, first_name, last_name).

POST /api/v1/clients

Create client. Required: email, first_name, last_name. Optional: company_name, password (auto-generated if omitted).

{"email":"[email protected]","first_name":"John","last_name":"Doe","company_name":"Acme"}

Validation: Email must be unique. Returns EMAIL_EXISTS (400) if duplicate.

Response 201: {"success":true,"data":{"id":1,"uuid":"..."},"message":"Client created"}

PUT /api/v1/clients/{id}

Update client. Body: email, first_name, last_name, company_name, status. Partial updates supported.

DELETE /api/v1/clients/{id}

Soft delete (sets deleted_at or status=inactive).