List branches

GET

/v1/branches

GET

/v1/branches

Returns the branches the key can read, sorted by name. Needs branches:read. Phone and tax number are left out unless you add include=contact.

Authorization

bearerAuth

headerAuthorizationBearer <api_key>

Query Parameters

include?"contact"

contact. Adds the branch phone number and tax number. Left out: neither.

Value in"contact"

Response Body

Branches, sorted by name

application/json

response

data*array<>

meta*

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/branches?include=contact'

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/branches?include=contact'

Example ResponseSchema

{
  "data": [
    {
      "id": "YOUR_BRANCH_ID",
      "name": "Camden",
      "isActive": true,
      "currency": "GBP",
      "address": {
        "line1": "12 Parkway",
        "line2": null,
        "town": "London",
        "county": null,
        "postCode": "NW1 7AA"
      },
      "location": "Camden",
      "phone": "020 7946 0123",
      "taxNumber": "GB123456789",
      "channels": {
        "online": true,
        "collection": true,
        "delivery": true,
        "kiosk": false,
        "table": true
      }
    }
  ],
  "meta": {
    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"
  }
}

{  "data": [    {      "id": "YOUR_BRANCH_ID",      "name": "Camden",      "isActive": true,      "currency": "GBP",      "address": {        "line1": "12 Parkway",        "line2": null,        "town": "London",        "county": null,        "postCode": "NW1 7AA"      },      "location": "Camden",      "phone": "020 7946 0123",      "taxNumber": "GB123456789",      "channels": {        "online": true,        "collection": true,        "delivery": true,        "kiosk": false,        "table": true      }    }  ],  "meta": {    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"  }}

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body