PHphorest
Branch

List branches

Changed on

Get a list of branches for the specified business id

get/api/business/{businessId}/branch

Request

Path parameters

businessIdstring required

Query parameters

service_idstring

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.

service_internet_enabledboolean

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.

number of branches to return, max is 200

page number, default is 0 and is optional

Response

Branches listed

Example response

{
  "_embedded": {
    "branches": [
      {
        "branchId": "ab123",
        "name": "Wicklow Street",
        "timeZone": "Europe/London",
        "latitude": 53.200905,
        "longitude": -6.111074,
        "streetAddress1": "56",
        "streetAddress2": "Haughton Rd",
        "city": "London",
        "state": "County Durham",
        "postalCode": "DL1 1ST\"",
        "country": "United Kingdom",
        "currencyCode": "GBP",
        "accountId": 1234
      }
    ]
  }
}

Changes

  • beea6ef29634Revision changes
    • info

      added the new optional query request parameter service_id

    • info

      added the new optional query request parameter service_internet_enabled