Clients

Endpoints for accessing client data.

Client list

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	ClientItem[]	List of clients

ClientItem

Field	Type	Description
IdClient	uuid	Client identifier
FullName	string	Client full name
PersonalId	string	Personal ID or other identifier
Phone	string	Phone number
Email	string	Email address

---

Extended client list

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	Number of records per page, max. 100 (default 25)
Active	bool	no	Filter by client activity (true = active, false = inactive). Defaults to true when omitted.
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

Field	Type	Description
Page	int	Current page
PageSize	int	Number of records per page
Results	ClientItem[]	List of clients

ClientItem

Field	Type	Description
IdClient	uuid	Client identifier
FullName	string	Client full name
Active	bool	Whether the client is active
PersonalInfo	ClientPersonalInfo	Personal details of the client
ContactInfo	ClientContactInfo	Contact details of the client

ClientPersonalInfo

Field	Type	Description
Firstname	string	First name
Lastname	string	Last name
Education	string	Title before name
EducationAfter	string	Title after name
PersonalId	string	Personal ID or other identifier
DateOfBirth	datetime	Date of birth

ClientContactInfo

Field	Type	Description
Phone	string	Phone number
Email	string	Email
Street	string	Street
City	string	City
Post	string	ZIP code

Client detail

GET /api/v1/Client/Detail/{idClient}

Returns 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 doctor
Location	Client location
Insurance	Health insurance provider
Medical	Allergies and medication
Status	Client status (active / inactive)
Tags	Client tags

Client appointments

GET /api/v1/Client/{idClient}/Appointments

Returns the latest past and upcoming future appointments of the client.

Availability

Client appointments are available only for Business and Enterprise plans.

Path parameters

Parameter	Type	Required	Description
idClient	uuid	yes	Client identifier

Query parameters

Parameter	Type	Required	Default	Description
PreviousLimit	int	no	10	Number of previous appointments, max. 50
FutureLimit	int	no	10	Number of future appointments, max. 50

Response

Field	Type	Description
PreviousAppointments	AppointmentItem[]	Previous appointments
FutureAppointments	AppointmentItem[]	Future appointments

AppointmentItem

Field	Type	Description
Appointment	AppointmentInfo	Appointment details
Client	AppointmentClient	Client details
Staff	AppointmentStaff	Staff details
Service	AppointmentService	Service details

AppointmentInfo

Field	Type	Description
IdAppointment	uuid	Appointment identifier
StartDate	datetime	Appointment start
EndDate	datetime	Appointment end
Description	string	Appointment description
Status	string	Appointment status
OnlineBooked	bool	Booked online
Confirmed	bool	Confirmed appointment

AppointmentClient

Field	Type	Description
IdClient	uuid	Client identifier
ClientName	string	Client name from appointment

AppointmentStaff

Field	Type	Description
IdStaff	uuid	Staff identifier
StaffName	string	Staff name

AppointmentService

Field	Type	Description
IdService	uuid	Service identifier
ServiceCaption	string	Service name

Error states

Status	Code	Description
404	CLIENT_NOT_FOUND	Client with the given idClient does not exist