---
title: "List breaks"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/break"
tags: ["Break"]
---

# List breaks

`GET /api/business/{businessId}/branch/{branchId}/break`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/break`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/break/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `from_date` string, date, required
- `to_date` string, date, required
- `staff_id` string
- `room_id` string
- `machine_id` string

## Response `200`

Breaks listed

- DataPagedModelBreakResponse
  - `_embedded` object
    - `breaks` BreakResponse[]
      - `breakDate` string, date
      - `startTime` string
      - `endTime` string
      - `staffId` string
      - `roomId` string
      - `machineId` string
      - `label` string
      - `paidBreak` boolean
      - `breakId` string
      - `version` integer
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)