BillOS v1
Console llms.txt OpenAPI
GET/businesses/{bid}/branding-themes/{tid}

Read a branding theme

GET /businesses/{bid}/branding-themes/{tid}

Requires the businesses scope.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.
tidstringrequiredTheme id.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
themeBrandingThemerequiredAnother look for the same business's documents (Xero calls them branding themes): its own logo, colour, design, tagline, footer, website, signature and, optionally, a bank account, phone and email to print. The business's own branding is the main design. A theme never changes who issues: the business's name, tax id and address head every document whatever theme it prints in. Archived, never deleted.

Errors: 400, 401, 403, 404, 429. Every failure answers { "error", "reason", "hint", "param", "doc_url", "retryable", "request_id" }: branch on reason, and read hint for what to change (https://docs.billos.co.il/errors.md).

PreviousCreate a branding theme NextUpdate or archive a branding theme
On this page
Path parametersResponse
GET /businesses/{bid}/branding-themes/{tid} 
curl -X GET "$BASE/businesses/$BID/branding-themes/{tid}" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/branding-themes/{tid}`, {
  method: 'GET',
  headers: {
    'X-Api-Key': KEY,
  },
})
const data = await res.json()
if (!data.ok) throw new Error(data.reason)
import requests
res = requests.get(
    f"{BASE}/businesses/{BID}/branding-themes/{tid}",
    headers={"X-Api-Key": KEY},
)
data = res.json()
Set BASE to https://api.billos.co.il/v1 and KEY to your bk_live_… key, or a bk_test_… key to run it against the sandbox.
Manage your businesses, keys and webhooks in the BillOS Console.