v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Branch Service

List branch services

Get a list of branch services for the specified business id and branch id. List can be filtered by service category id, possibility to include archived branch services in the list and option to fetch online categories of branch services

get/api/business/{businessId}/branch/{branchId}/service

Path parameters

businessIdstring required
branchIdstring required

Query parameters

category_idstring

service category id to filter by

includeArchivedboolean

include archived branch services in the list

fetch_online_categoryboolean

include online categories of branch services

number of branch service records to return, max is 100

page number, default is 0 and is optional

Response

Branch services listed

Example response

{
  "_embedded": {
    "services": [
      {
        "serviceId": "ab123",
        "version": 1,
        "categoryId": "category1",
        "duration": 20,
        "gapTime": 15,
        "name": "Blow dry",
        "price": 25.5,
        "disqualifiedStaff": [
          "staff1",
          "staff2"
        ],
        "machines": [
          "machine1",
          "machine2"
        ],
        "rooms": [
          "room1",
          "room2"
        ],
        "taxRates": [
          "taxRateRef",
          "taxRateRef2"
        ],
        "internetName": "online name",
        "staffCategories": {
          "prices": [
            {
              "id": "priceCategory1",
              "price": 55.1
            }
          ]
        },
        "userDurations": [
          {
            "userRef": "userID1",
            "duration": 60
          }
        ],
        "userGapTimes": [
          {
            "userRef": "userID1",
            "gapTime": 10
          }
        ],
        "department": {
          "id": "ab123",
          "name": "Hair Department"
        },
        "categoryName": "category name",
        "internetDescription": "service description",
        "internetServiceCategories": [
          {
            "id": "ab123",
            "name": "Cut & Style"
          }
        ]
      }
    ]
  }
}