DocsAPI ReferenceBranch/bff/branch/detail
getBranchAdmin BFF

/bff/branch/detail

Returns full branch detail including basic fields, address, manager contact, regular opening hours, opening hour exceptions, emails, phones and main photo URL.

BranchgetBffBranchDetail

Parameters

1 query

1 total
Query · 1
slugstringRequired

Branch slug.

Request

GET /bff/branch/detail

get
curl -X GET "https://api.bizkithub.com/bff/branch/detail?slug=prague-central" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "id": "example_id",
  "slug": "example_slug",
  "name": "example_name",
  "description": "example_description",
  "internalCode": "example_internalCode",
  "active": false,
  "url": "example_url",
  "latitude": 0,
  "longitude": 0,
  "branchContact": {
    "contactId": "example_contactId",
    "name": "example_name",
    "email": "example_email",
    "companyName": "example_companyName"
  },
  "parentBranch": {
    "slug": "example_slug",
    "name": "example_name"
  },
  "operatingCompany": {
    "contactId": "example_contactId",
    "name": "example_name",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber"
  },
  "franchiseFeePercentage": 0,
  "people": [
    {
      "id": "example_id",
      "contactId": "example_contactId",
      "role": "example_role",
      "customLabel": "example_customLabel",
      "position": 0,
      "name": "example_name",
      "email": "example_email",
      "companyName": "example_companyName"
    }
  ],
  "establishedDate": "example_establishedDate",
  "openedDate": "example_openedDate",
  "currentClosure": {
    "id": "example_id",
    "startDate": "example_startDate",
    "endDate": "example_endDate",
    "reason": "example_reason"
  },
  "termsAndConditions": "example_termsAndConditions",
  "complaintsProcedure": "example_complaintsProcedure",
  "privacyPolicy": "example_privacyPolicy",
  "internalDescription": "example_internalDescription",
  "staffInstructions": "example_staffInstructions",
  "aiInstructions": "example_aiInstructions",
  "mainPhotoUrl": "example_mainPhotoUrl",
  "address": {
    "id": "example_id",
    "firstName": "example_firstName",
    "lastName": "example_lastName",
    "companyName": "example_companyName",
    "streetAddress": "example_streetAddress",
    "city": "example_city",
    "cityPart": "example_cityPart",
    "stateRegion": "example_stateRegion",
    "postalCode": "example_postalCode",
    "country": "example_country",
    "notice": "example_notice"
  },
  "openingHours": {
    "regular": [
      {
        "id": "example_id",
        "dayOfWeek": 0,
        "definition": "example_definition",
        "description": "example_description",
        "active": false
      }
    ],
    "exceptions": [
      {
        "id": "example_id",
        "date": "example_date",
        "isOpen": false,
        "reason": "example_reason"
      }
    ]
  },
  "emails": [
    {
      "id": "example_id",
      "email": "example_email",
      "role": "example_role"
    }
  ],
  "phones": [
    {
      "id": "example_id",
      "phone": "example_phone",
      "role": "example_role"
    }
  ],
  "calendars": [
    {
      "id": "example_id",
      "name": "example_name",
      "code": "example_code",
      "colorHex": "example_colorHex"
    }
  ],
  "products": [
    {
      "id": "example_id",
      "code": "example_code",
      "slug": "example_slug",
      "active": false,
      "mainImageId": 0
    }
  ],
  "locks": [
    {
      "lockId": 0,
      "alias": "example_alias",
      "electricQuantity": 0,
      "hasGateway": false,
      "active": false
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key