Skip to content

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

ParameterTypeRequiredDefaultDescription
pageintno1Page number
pageSizeintno25Number of records per page (max. 100)

Response

FieldTypeDescription
PageintCurrent page
PageSizeintNumber of records per page
Results[].IdClientuuidClient identifier
Results[].FullNamestringClient full name
Results[].PersonalIdstringPersonal ID or other identifier
Results[].PhonestringPhone number
Results[].EmailstringEmail address

GET /api/v1/Client/Extended

Returns a paginated list of clients with extended information and filtering support.

Parameters

ParameterTypeRequiredDescription
pageintnoPage number (default 1)
pageSizeintnoRecords per page, max. 100 (default 25)
activeboolnoFilter by client activity (true = active, false = inactive)
filterstringnoFull-text search (name, email, phone, etc.)
idStaffuuidnoFilter by assigned staff member
idLocationuuidnoFilter 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

ParameterTypeRequiredDescription
idClientuuidyesClient identifier

Response

SectionDescription
PersonalInfoPersonal details (name, personal ID, date of birth, gender)
ContactInfoContact and address details
StaffAssigned physician
LocationClient's location
InsuranceHealth insurance provider
MedicalAllergies and medications
StatusClient status (active / inactive)

Error states

StatusCodeDescription
404CLIENT_NOT_FOUNDClient with the given idClient does not exist