DocsAPI ReferenceBranch/api/v1/branch/detail
getBranchPublic API v1

/api/v1/branch/detail

Returns the full publicly displayable detail of a single active branch identified by slug. Includes address (without internal delivery notes), opening hours (regular + exceptions), public e-mails and phones, branch type, parent branch reference, operating company (name + IČO + DIČ — public business-register information), public legal documents (Terms & Conditions, complaints procedure, privacy policy) and the list of associated people (role and display name only).

Internal data (internal code, internal description, staff instructions, AI system prompt, internal billing contact, attached calendars / products / locks, monetary write-offs) is deliberately excluded from this endpoint.

branchgetApiV1BranchDetail

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

slugstringRequired

Branch slug.

Request

GET /api/v1/branch/detail

get
curl -X GET "https://api.bizkithub.com/api/v1/branch/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&slug=prague-central" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "id": "prague-central",
  "slug": "prague-central",
  "name": "Prague Central",
  "description": "example_description",
  "url": "example_url",
  "latitude": 50.0755,
  "longitude": 14.4378,
  "parentBranch": {
    "slug": "example_slug",
    "name": "example_name"
  },
  "operatingCompany": {
    "name": "example_name",
    "companyRegistrationNumber": "example_companyRegistrationNumber",
    "taxIdentificationNumber": "example_taxIdentificationNumber"
  },
  "termsAndConditions": "example_termsAndConditions",
  "complaintsProcedure": "example_complaintsProcedure",
  "privacyPolicy": "example_privacyPolicy",
  "mainPhotoUrl": "example_mainPhotoUrl",
  "address": {
    "firstName": "example_firstName",
    "lastName": "example_lastName",
    "companyName": "example_companyName",
    "streetAddress": "example_streetAddress",
    "city": "example_city",
    "cityPart": "example_cityPart",
    "stateRegion": "example_stateRegion",
    "postalCode": "example_postalCode",
    "country": "CZ"
  },
  "openingHours": {
    "regular": [
      {
        "dayOfWeek": 0,
        "definition": "example_definition",
        "description": "example_description"
      }
    ],
    "exceptions": [
      {
        "date": "2026-12-24",
        "isOpen": false,
        "reason": "example_reason"
      }
    ]
  },
  "emails": [
    {
      "email": "info@example.com",
      "role": "example_role"
    }
  ],
  "phones": [
    {
      "phone": "+420 777123456",
      "role": "example_role"
    }
  ],
  "people": [
    {
      "role": "example_role",
      "customLabel": "example_customLabel",
      "name": "example_name"
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key