Borkol Docs home

Getting Started

Business profile

Read the store's public business details, social links and content languages.

View as Markdown

One endpoint returns the public side of the merchant's business profile: how the business is named and reached, where it is registered, which social profiles it links, and which languages its content is written in. Use it for a storefront footer, a contact page or a language switcher. The merchant edits these values in the dashboard under Settings → Business.

The endpoint takes a tenant API key carrying the tenant:read scope, sent as Authorization: Bearer {api_key}. It does not depend on any module. A key without the scope gets 403 {"message": "Invalid ability provided."}. The shared tenant rate limit of 120 requests per minute applies.

GET /v1/api/business

Returns the public allow-list of the business profile. Banking, signer, sender and terms fields are never part of it. The call does not create a profile: a store that has not filled in its profile yet answers 200 with every text field null, social_links as [], and the default language.

Request

Request
curl https://api.borkol.com/v1/api/business \
  -H "Authorization: Bearer {api_key}"

Response

Response
{
  "data": {
    "trade_name": "Sunrise Bakery",
    "legal_name": "Sunrise Bakery BV",
    "email": "hello@bakery.example",
    "phone": "+31 20 123 4567",
    "website": "https://bakery.example",
    "street": "Kerkstraat",
    "house_number": "12",
    "postal_code": "2011 AB",
    "city": "Haarlem",
    "country": "NL",
    "registration_number": "12345678",
    "vat_id": "NL123456789B01",
    "social_links": [
      { "platform": "instagram", "url": "https://www.instagram.com/sunrisebakery", "label": null },
      { "platform": "other", "url": "https://bakery.example/blog", "label": "Blog" }
    ],
    "locale": "nl",
    "content_locales": ["nl", "en"]
  }
}

Fields

FieldTypeDescription
trade_namestring or nullName the business trades under.
legal_namestring or nullRegistered legal name.
emailstring or nullPublic contact email.
phonestring or nullPublic contact phone number.
websitestring or nullThe business's own website.
streetstring or nullStreet of the business address.
house_numberstring or nullHouse number.
postal_codestring or nullPostal code.
citystring or nullCity.
countrystring or nullTwo-letter country code, uppercase, for example NL.
registration_numberstring or nullChamber of commerce or company registration number.
vat_idstring or nullVAT number, uppercase.
social_linksarrayThe social profiles the merchant links, in the order they set. Empty array when none. Each item is described below.
localestringThe store's default language, a language tag such as nl.
content_localesarray of stringsThe languages the store's content is written in. Always contains locale. Same list as the languages that localized Objects values are cut down to.
FieldTypeDescription
platformstringOne of instagram, facebook, x, linkedin, youtube, tiktok, pinterest, threads, bluesky, snapchat, whatsapp, telegram, github, behance, dribbble, vimeo, reddit, discord, mastodon, twitch, spotify, medium, other.
urlstringAn https:// address. For every platform except mastodon and other the host belongs to that platform.
labelstring or nullDisplay text. Always present for other, optional (often null) for the rest.

The platform list can grow. Treat a platform you do not know as a plain link and show it with its label or url.

Errors

StatusWhen
401Missing or invalid API key.
403The key does not carry the tenant:read scope.
429Rate limit reached. See Errors and rate limits.