Services
List services
GET /v1/services
Scope: services:read
| Parameter | In | Required |
|---|
categoryId | query | No |
locationId | query | No |
membershipId | query | No |
q | query | No |
includeArchived | query | No |
Create a service
POST /v1/services
Scope: services:create
| Body field | Type | Required |
|---|
kind | string | No |
name | string | Yes |
code | | No |
categoryId | | No |
colour | | No |
photoFileId | | No |
deposit | object | No |
minAge | | No |
restrictions | object | No |
durationDays | | No |
sku | | No |
accountCode | | No |
invoiceItemName | | No |
invoiceDisplayText | | No |
defaultDiagnosis | | No |
patchTestRequired | boolean | No |
packageOnly | boolean | No |
requiresOrder | boolean | No |
orderFields | array | No |
restrictCompanyIds | array | No |
pricingRule | | No |
coolingOffHours | | No |
requiredCredential | | No |
supervisingClinicianId | | No |
contraindications | array | No |
availability | string | No |
price | integer | No |
cost | integer | No |
durationMin | integer | Yes |
bufferMin | integer | No |
capacity | | No |
timeline | array | No |
roles | array | No |
taxRateId | | No |
online | object | No |
care | object | No |
staff | array | No |
locations | array | No |
roomIds | array | No |
equipment | array | No |
custom | object | No |
bundle | object | No |
priceListPrices | array | No |
thirdPartyPrices | array | No |
Get a service
GET /v1/services/{id}
Scope: services:read
| Parameter | In | Required |
|---|
id | path | Yes |
Update a service
PATCH /v1/services/{id}
Scope: services:update
| Parameter | In | Required |
|---|
id | path | Yes |
If-Match | header | No |
| Body field | Type | Required |
|---|
kind | string | No |
name | string | No |
code | | No |
categoryId | | No |
colour | | No |
photoFileId | | No |
deposit | object | No |
minAge | | No |
restrictions | object | No |
durationDays | | No |
sku | | No |
accountCode | | No |
invoiceItemName | | No |
invoiceDisplayText | | No |
defaultDiagnosis | | No |
patchTestRequired | boolean | No |
packageOnly | boolean | No |
requiresOrder | boolean | No |
orderFields | array | No |
restrictCompanyIds | array | No |
pricingRule | | No |
coolingOffHours | | No |
requiredCredential | | No |
supervisingClinicianId | | No |
contraindications | array | No |
availability | string | No |
price | integer | No |
cost | integer | No |
durationMin | integer | No |
bufferMin | integer | No |
capacity | | No |
timeline | array | No |
roles | array | No |
taxRateId | | No |
online | object | No |
care | object | No |
staff | array | No |
locations | array | No |
roomIds | array | No |
equipment | array | No |
custom | object | No |
bundle | object | No |
priceListPrices | array | No |
thirdPartyPrices | array | No |
archived | boolean | No |
