Retrieve a branch

GET

/v1/branches/{id}

GET

/v1/branches/{id}

Returns one branch. Needs branches:read. A branch outside the key's branch list returns 403 branch_forbidden, not 404.

Authorization

bearerAuth

headerAuthorizationBearer <api_key>

Path Parameters

id*string

String. The branch id from List branches.

Match^[A-Za-z0-9_-]{1,128}$

Query Parameters

include?"contact"

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

Value in"contact"

Response Body

The branch

application/json

response

data*

meta*

Example Request

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

Example Request

curl -X GET 'https://europe-west2-fyre-pos.cloudfunctions.net/publicApi/v1/branches/YOUR_BRANCH_ID?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",
    "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",    "channels": {      "online": true,      "collection": true,      "delivery": true,      "kiosk": false,      "table": true    }  },  "meta": {    "requestId": "6f1c2a9e-4b1d-4c4b-9d8e-0a1b2c3d4e5f"  }}

Retrieve a branch

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Query Parameters

Response Body