/bff/branch/tree

Flat list of all branches in the authenticated organisation with parent-slug, branch type, operating-company summary and direct-child count. The admin assembles the tree client-side so it can drive expand/collapse state without round-trips.

BranchgetBffBranchTree

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:

slugstringRequired

namestringRequired

parentSlugstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

branchType"own" | "franchise" | "partner"Required

activebooleanRequired

childCountnumberRequired

operatingCompanyobjectOptional

contactIdstringRequired

namestringOptional

Response example

application/json

{
  "items": [
    {
      "slug": "example_slug",
      "name": "example_name",
      "active": false,
      "childCount": 0,
      "operatingCompany": {
        "contactId": "example_contactId",
        "name": "example_name"
      }
    }
  ]
}

Request example

GET /bff/branch/tree

get

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