/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

No parameters

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

Request

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"

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key