PHphorest
Break

List breaks

Get a list of breaks for the specified business id and branch id, with a maximum one month date range. List can be filtered by date of break, staff id, room id and machine id

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

Request

Path parameters

businessIdstring required
branchIdstring required

Query parameters

from_datestring date required

from date to query from. yyyy-MM-dd

to_datestring date required

to date (inclusive) to query to. yyyy-MM-dd

staff_idstring

staff id to filter by

room_idstring

room id to filter by

machine_idstring

machine id to filter by

number of breaks to return, max is 200

page number, default is 0 and is optional

Response

Breaks listed

Example response

{
  "_embedded": {
    "breaks": [
      {
        "breakDate": "2018-01-01",
        "startTime": "12:30:00",
        "endTime": "13:00:00",
        "staffId": "staffid",
        "roomId": "roomid",
        "machineId": "machineid",
        "label": "lunch break",
        "paidBreak": true,
        "breakId": "ab123",
        "version": 1
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.