BizKitHub
DocsAPI ReferenceBranch/api/v1/branch/my-branch-list
getBranchPublic API v1

/api/v1/branch/my-branch-list

Returns branches (pobočky) of the organisation the currently authenticated user operates.

Resolution rule:

  • If the caller's contact is linked to an organisation member holding the root permission (directly or via a role), the response contains every active branch in the organisation — the same set /branch/list would return without paging.
  • Otherwise the response contains only branches on which the caller is listed as the technician in shop__branch_person.

Each item carries only the publicly displayable subset of branch information. Use /branch/detail?slug=… to fetch the full public detail of a specific branch.

branchgetApiV1BranchMy-branch-list

Parameters

2 query

Query parameters

· 2
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Branch slug (used as identifier in /detail).

Exampleprague-central
slugstringRequired

URL-safe unique branch slug.

Exampleprague-central
namestringRequired

Branch display name.

ExamplePrague Central
descriptionstringOptional

Short branch description.

urlstringOptional

Public branch URL.

latitudenumberOptional

Branch GPS latitude.

Example50.0755
longitudenumberOptional

Branch GPS longitude.

Example14.4378
mainPhotoUrlstringOptional

URL of the main public photo.

addressSummarystringOptional

Short rendered address (street, ZIP, city).

ExampleHlavní 1, 110 00, Praha
branchType"own" | "franchise" | "partner"Required

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

Exampleown
distanceKmnumberOptional

Great-circle distance from the reference GPS point in kilometres. Present only when both latitude and longitude query parameters are provided and the branch has GPS coordinates filled in.

Example3.42
itemCountnumberRequired

Number of branches returned.

Example3

Response example

application/json
{
  "items": [
    {
      "id": "prague-central",
      "slug": "prague-central",
      "name": "Prague Central",
      "description": "example_description",
      "url": "example_url",
      "latitude": 50.0755,
      "longitude": 14.4378,
      "mainPhotoUrl": "example_mainPhotoUrl",
      "addressSummary": "Hlavní 1, 110 00, Praha",
      "branchType": "own",
      "distanceKm": 3.42
    }
  ],
  "itemCount": 3
}

Request example

GET /api/v1/branch/my-branch-list

get
curl -X GET "https://api.bizkithub.com/api/v1/branch/my-branch-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg" \
  -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