/bff/branch/holding-tree

Per-organisation DAG of company-to-company relationships plus the branches each company operates. Returned as flat lists (companies, links, branchesByCompany) so the admin renderer can walk the DAG safely (deduping nodes when the same company appears under multiple parents).

BranchgetBffBranchHolding-tree

Parameters

No parameters required

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

Response schema

1 status code documented

200Success

companiesobject[]Required

Each array item:

contactIdstringRequired

namestringRequired

companyRegistrationNumberstringOptional

taxIdentificationNumberstringOptional

branchCountnumberRequired

linksobject[]Required

Each array item:

idstringRequired

parentContactIdstringRequired

childContactIdstringRequired

relationType"subsidiary" | "franchisee" | "sister" | "joint_venture" | "silent_partner"Required

ownershipPercentnumberOptional

validFromstringOptional

validTostringOptional

notesstringOptional

branchesByCompanyobjectRequired

Response example

application/json

{
  "companies": [
    {
      "contactId": "example_contactId",
      "name": "example_name",
      "companyRegistrationNumber": "example_companyRegistrationNumber",
      "taxIdentificationNumber": "example_taxIdentificationNumber",
      "branchCount": 0
    }
  ],
  "links": [
    {
      "id": "example_id",
      "parentContactId": "example_parentContactId",
      "childContactId": "example_childContactId",
      "ownershipPercent": 0,
      "validFrom": "example_validFrom",
      "validTo": "example_validTo",
      "notes": "example_notes"
    }
  ],
  "branchesByCompany": {}
}

Request example

GET /bff/branch/holding-tree

get

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