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

/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

Query parameters

· 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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
pagestringOptional

Page number (starting from 1).

Default: 1
Example1
latitudenumberOptional

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
Example50.0755
longitudenumberOptional

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

Range: -180–180
Example14.4378

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

Total number of active branches.

Example12

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

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key