API Reference

List breaks

get
http://api-gateway-eu.phorest.com/third-party-api-server/api/business//branch//break

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Query Params
date
required

from date to query from. yyyy-MM-dd

date
required

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

string

staff id to filter by

string

room id to filter by

string

machine id to filter by

integer
Defaults to 20

number of breaks to return, max is 100

integer
Defaults to 0

page number, default is 0 and is optional

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?