BizKitHub
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

2 query

Query parameters

· 2
slugstringRequired

Branch slug.

Exampleprague-central
localestringOptional

Locale code (e.g. 'cs', 'en') used to pick the preview text on the Documents tab. Falls back to any available translation and reports which locale it picked via documents[].previewLocaleCode. Omit to disable preferential ordering.

Exampleexample_locale

Response schema

1 status code documented

200Success
idstringRequired
slugstringRequired
namestringRequired
descriptionstringOptional
internalCodestringOptional
activebooleanRequired
urlstringOptional
latitudenumberOptional
longitudenumberOptional
branchContactobjectOptional
contactIdstringRequired

CuRefNo of the linked contact.

namestringOptional
emailstringOptional
companyNamestringOptional
branchType"own" | "franchise" | "partner"Required

Branch kind declared by the operator. "own" = the organisation runs the branch directly; "franchise" = a third-party franchisee runs it under the organisation's brand; "partner" = a cooperating but independent business (e.g. white-label outlet).

parentBranchobjectOptional
slugstringRequired

Slug of the operational parent (regional flagship / HQ).

namestringRequired
branchType"own" | "franchise" | "partner"Optional
operatingCompanyobjectOptional
contactIdstringRequired

CuRefNo of the legal entity operating this branch.

namestringOptional
companyRegistrationNumberstringOptional

Czech IČO (or local equivalent).

taxIdentificationNumberstringOptional

Czech DIČ (or local equivalent).

franchiseFeePercentagenumberOptional

Franchise fee percent skimmed off the branch turnover (0–100). Omitted when the branch has no franchise economics configured.

peopleobject[]Required
Each array item:
idstringRequired

Internal id of the link row (used to update/remove).

contactIdstringRequired

CuRefNo of the linked contact.

rolestringRequired

Role enum — see BRANCH_PERSON_ROLES.

customLabelstringOptional

Free-text label that overrides the role display.

positionnumberRequired

Sort position.

namestringOptional
emailstringOptional
companyNamestringOptional
establishedDatestringOptional

Legal incorporation / business-registry date (ISO timestamp). Optional — nullable in DB.

openedDatestringRequired

Date the branch started serving customers (ISO timestamp). Required — drives the financial roll-up bucket key.

currentClosureobjectOptional
idstringRequired

External id (24-char) — use it for /closure-update or /closure-delete.

startDatestringRequired

ISO timestamp the closure began.

endDatestringOptional

ISO timestamp the closure ends. Omitted = open-ended.

reasonstringRequired

Operator-supplied reason for the closure.

mainPhotoUrlstringOptional
addressobjectOptional
idstringRequired

External address identifier.

firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
streetAddressstringOptional
citystringOptional
cityPartstringOptional
stateRegionstringOptional
postalCodestringOptional
countrystringOptional

ISO 3166-1 alpha-2 country code.

noticestringOptional
openingHoursobjectRequired
regularobject[]Required
Each array item:
idstringRequired
dayOfWeeknumberRequired

0 = Monday, 6 = Sunday.

Range: 0–6
definitionstringRequired

Time range definition (e.g. "08:00-17:00").

descriptionstringOptional
validFromDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
validToDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
activebooleanRequired
exceptionsobject[]Required
Each array item:
idstringRequired
datestringRequired

Exception date (ISO YYYY-MM-DD).

isOpenbooleanRequired
reasonstringOptional
emailsobject[]Required
Each array item:
idstringRequired
emailstringRequired
rolestringOptional
verifiedDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
phonesobject[]Required
Each array item:
idstringRequired
phonestringRequired
rolestringOptional
verifiedDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
calendarsobject[]Required
Each array item:
idstringRequired

Calendar ID.

namestringRequired
codestringRequired
colorHexstringOptional

6-char hex color without # prefix.

productsobject[]Required
Each array item:
idstringRequired

Product ID.

codestringRequired
slugstringRequired
activebooleanRequired
mainImageIdnumberOptional
locksobject[]Required
Each array item:
lockIdnumberRequired

External TTLock identifier (matches the lock detail URL).

aliasstringOptional

Operator-defined display name.

electricQuantitynumberOptional

Battery level in percent (0–100), if reported.

hasGatewaybooleanOptional

Whether the lock is reachable via a Wi-Fi gateway.

activebooleanRequired

Whether the lock is actively monitored.

documentsobject[]Required
Each array item:
slotKey"terms" | "complaints" | "privacy" | "operational" | "internalDescription" | "staff" | "ai"Required

Which document slot this row represents. Fixed 7-way enum — mirrors the FK columns on shop__branch.

postExternalIdstring | nullRequired

Post external id (16 chars). Null when the slot has no linked post yet.

One of 2:
Variant 1
string
Variant 2
null
postIdnumber | nullRequired

Post internal id — used by BFF calls that address the post directly (e.g. auto-translate).

One of 2:
Variant 1
number
Variant 2
null
visibility"public" | "private" | "unlisted" | "subscribe" | nullRequired

Post visibility. Null for empty slots. Branch docs default to public/private per slot (see createBranchDocuments).

One of 5:
Variant 1
"public"
Variant 2
"private"
Variant 3
"unlisted"
Variant 4
"subscribe"
Variant 5
null
localeCodesstring[]Required

Locale codes (e.g. 'cs', 'en') whose content__post_locale row has non-empty content.

updatedDatestring | nullRequired

Parent post's updated_date (ISO). Null for empty slots.

One of 2:
Variant 1
string
Variant 2
null
previewTextstring | nullRequired

First ~140 chars of the preview locale, markdown-stripped. Null when no locale has any content.

One of 2:
Variant 1
string
Variant 2
null
previewLocaleCodestring | nullRequired

Locale the preview text was taken from. Equals the requested locale when it has content; otherwise a fallback locale. Null when no locale has content (in which case previewText is also null).

One of 2:
Variant 1
string
Variant 2
null
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "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"
  },
  "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
    }
  ],
  "documents": [
    {
      "localeCodes": [
        "string"
      ]
    }
  ]
}

Request example

GET /bff/branch/detail

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key