/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

No parameters

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

Request

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"

Response

JSON payload

{
  "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
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key