Skip to main content

Services API

List​

GET /services/get/

Add full=true to include service data properties.

Create​

POST /services/add/

{
  "name": "Initial consultation",
  "description": "A 45-minute consultation",
  "color": "#0369a1"
}

The optional class field, when supplied, must be appointment.

Edit​

POST /services/edit/ requires id. Additional top-level fields and values inside data are stored as service properties.

Remove​

POST /services/remove/?id=s_example

A service with reservations cannot be removed. Deactivate it instead when historical records must remain.

Response​

GET /services/get/ returns the services in response. The fields follow the Service schema of the API reference; values here are examples.

{
  "status": "OK",
  "response": [
    {
      "id": "s_demo",
      "name": "Initial consultation",
      "description": "A 45-minute consultation",
      "class": "appointment",
      "color": "#0369a1"
    }
  ]
}

With full=true, each service also has data, its settings. Creation returns the new id.

Errors​

HTTP statusWhen
400The request is not valid, for example a required field is missing.
401The token is missing or not valid.
403The token has no write scope, or the service has reservations and cannot be removed.
404No service has this id.
Last updated on