v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Branch

List branches

Get a list of branches for the specified business id

get/api/business/{businessId}/branch

Path parameters

businessIdstring required

Query parameters

number of branches to return, max is 100

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
      }
    ]
  }
}