BizKitHub
DocsAPI ReferenceBranch/bff/branch/list
getBranchAdmin BFF

/bff/branch/list

Returns a paginated list of branches for the authenticated organisation. Branches are ordered by active status first, then by name ascending. Supports fulltext filter on name, slug, internal code and city.

BranchgetBffBranchList

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Branch slug (used as identifier in other endpoints).

slugstringRequired

URL-safe unique branch slug.

namestringRequired

Branch display name.

descriptionstringOptional

Short branch description.

internalCodestringOptional

Organisation-internal branch code.

activebooleanRequired

Whether the branch is active and visible.

urlstringOptional

Branch public URL.

latitudenumberOptional

Branch GPS latitude.

longitudenumberOptional

Branch GPS longitude.

mainPhotoUrlstringOptional

URL of the main photo.

addressSummarystringOptional

Short rendered address (street, ZIP, city).

openingHoursRegularobject[]Required
Each array item:
dayOfWeeknumberRequired

0 = Monday … 6 = Sunday.

Range: 0–6
definitionstringRequired

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

activebooleanRequired
openingHoursExceptionTodayobjectOptional
isOpenbooleanRequired
reasonstringOptional
branchType"own" | "franchise" | "partner"Required

Branch kind. Defaults to "own" for historical rows.

parentBranchSlugstringOptional

Slug of the operational parent branch, if any.

operatingCompanyNamestringOptional

Display name of the legal entity operating this branch. Doubles as the franchise brand label.

insertedDateDate | string | string | numberRequired

Creation date.

One of 4:
Variant 1
Date

Creation date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Last update date.

One of 4:
Variant 1
Date

Last update date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of branches matching the query.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "slug": "example_slug",
      "name": "example_name",
      "description": "example_description",
      "internalCode": "example_internalCode",
      "active": false,
      "url": "example_url",
      "latitude": 0,
      "longitude": 0,
      "mainPhotoUrl": "example_mainPhotoUrl",
      "addressSummary": "example_addressSummary",
      "openingHoursRegular": [
        {
          "dayOfWeek": 0,
          "definition": "example_definition",
          "active": false
        }
      ],
      "openingHoursExceptionToday": {
        "isOpen": false,
        "reason": "example_reason"
      },
      "parentBranchSlug": "example_parentBranchSlug",
      "operatingCompanyName": "example_operatingCompanyName"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/branch/list

get
curl -X GET "https://api.bizkithub.com/bff/branch/list" \
  -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