API Reference

List branches

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

Get a list of branches for the specified business id

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

Only return branches that offer this service: the branch is active and the service is neither archived nor deleted, at branch or business level. Use the serviceId returned by the service endpoints; it is the same in every branch. An id that no branch offers returns an empty page.

boolean

Requires service_id. true returns only branches where the service is enabled for online booking (the service's internetEnabled at that branch); false returns only branches where it is not.

integer
Defaults to 20

number of branches to return, max is 200

integer
Defaults to 0

page number, default is 0 and is optional

Responses

Updated 4 months 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 4 months ago

Did this page help you?