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

2 total
Query · 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

identityIdstringRequired

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

Request

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"

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key