Clients
Endpoints for accessing client data. Three levels of detail are available: a simplified list, an extended list with filtering, and client detail.
GET /api/v1/Client/Simple
Returns a paginated list of clients with basic information.
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | int | no | 1 | Page number |
pageSize | int | no | 25 | Number of records per page (max. 100) |
Response
| Field | Type | Description |
|---|---|---|
Page | int | Current page |
PageSize | int | Number of records per page |
Results[].IdClient | uuid | Client identifier |
Results[].FullName | string | Client full name |
Results[].PersonalId | string | Personal ID or other identifier |
Results[].Phone | string | Phone number |
Results[].Email | string | Email address |
GET /api/v1/Client/Extended
Returns a paginated list of clients with extended information and filtering support.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int | no | Page number (default 1) |
pageSize | int | no | Records per page, max. 100 (default 25) |
active | bool | no | Filter by client activity (true = active, false = inactive) |
filter | string | no | Full-text search (name, email, phone, etc.) |
idStaff | uuid | no | Filter by assigned staff member |
idLocation | uuid | no | Filter by location |
Response
The response has the same wrapper as /Client/Simple (Page, PageSize, Results[])
In addition to the basic fields, it includes further client details, notably nested objects:
PersonalInfo(personal details)ContactInfo(contact details)
GET /api/v1/Client/Detail/
Returns the detail of a specific client.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idClient | uuid | yes | Client identifier |
Response
| Section | Description |
|---|---|
PersonalInfo | Personal details (name, personal ID, date of birth, gender) |
ContactInfo | Contact and address details |
Staff | Assigned physician |
Location | Client's location |
Insurance | Health insurance provider |
Medical | Allergies and medications |
Status | Client status (active / inactive) |
Error states
| Status | Code | Description |
|---|---|---|
404 | CLIENT_NOT_FOUND | Client with the given idClient does not exist |