/api/v1/branch/list

Returns a paginated list of active branches (pobočky) of the organisation. Each item carries only the publicly displayable subset of branch information (name, description, GPS, public URL, main photo, summary address, branch type). Use /branch/detail?slug=… to fetch the full public detail of a specific branch.

When the latitude and longitude query parameters are both supplied, the result is sorted by great-circle (haversine) distance from that reference point ascending and each item carries an additional distanceKm field. Branches whose GPS coordinates are missing are placed at the end of the list.

branchgetApiV1BranchList

Parameters

4 query

4 total

Query · 4

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

pagestring

Page number (starting from 1).

Default: 1

latitudenumber

Reference GPS latitude. When provided together with longitude, branches are ordered by great-circle distance from this point (ascending) and each item carries a distanceKm field. Branches without GPS coordinates are placed last.

Range: -90–90

longitudenumber

Reference GPS longitude. Must be passed together with latitude — providing just one of the two is rejected.

Range: -180–180

Request

GET /api/v1/branch/list

get

curl -X GET "https://api.bizkithub.com/api/v1/branch/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&page=1&latitude=50.0755&longitude=14.4378" \
  -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": 12
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key