Services
Endpoints for retrieving the list of services used in appointments and online bookings.
Service list
GET /api/v1/Service/Simple
Returns a list of active services including basic settings.
Parameters
This endpoint has no parameters.
Response
Response is a ServiceItem[] array.
ServiceItem
| Field | Type | Description |
|---|---|---|
IdService | uuid | Service identifier |
Settings | ServiceSettings | General service settings |
ServiceSettings
| Field | Type | Description |
|---|---|---|
Caption | string | Service name |
Duration | int | Service duration in minutes |
Color | string | Service color (HEX) |
Extended service list
GET /api/v1/Service/Extended
Returns a list of services including basic settings, assigned staff, and online booking settings.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
IdStaff | uuid | no | Filter by assigned staff member |
Caption | string | no | Search in the service name |
IsOnlineBooking | bool | no | Filter by availability for online bookings |
Response
Response is a ServiceItem[] array.
ServiceItem
| Field | Type | Description |
|---|---|---|
IdService | uuid | Service identifier |
Staffs | uuid[] | List of staff identifiers assigned to the service |
Settings | ServiceSettings | General service settings |
OnlineBooking | ServiceOnlineBooking | Service settings for online bookings |
Service detail
GET /api/v1/Service/Detail/{idService}
Returns detail of a specific service including basic settings and online booking settings.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
idService | uuid | yes | Service identifier |
Response
| Field | Type | Description |
|---|---|---|
IdService | uuid | Service identifier |
Staffs | uuid[] | List of staff identifiers assigned to the service |
Settings | ServiceSettings | General service settings |
OnlineBooking | ServiceOnlineBooking | Service settings for online bookings |
ServiceSettings
| Field | Type | Description |
|---|---|---|
Caption | string | Service name |
Duration | int | Service duration in minutes |
Color | string | Service color (HEX) |
ServiceOnlineBooking
| Field | Type | Description |
|---|---|---|
NameOnline | string | Service name for online bookings |
Description | string | Service description for online bookings |
Cost | number | Service price |
Deposit | number | Service deposit |
IsOnline | bool | Whether the service is available for online bookings |
IsAuth | bool | Whether the service requires iKlient login |
Error states
| Status | Code | Description |
|---|---|---|
404 | SERVICE_NOT_FOUND | Service with the given idService does not exist |