BillOS v1
Console llms.txt OpenAPI
GET/businesses/{bid}/access

Who has access to a business

GET /businesses/{bid}/access

Requires the businesses scope.

Every person the owner let in (section 4, Shared access), newest first, revoked rows included. Owner only: a credential that holds the business by grant answers 404. Also returns the role presets and the Hebrew/English label of every scope, so a UI never keeps its own copy.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
accessarray of BusinessAccessrequired
rolesobjectPreset name → { label, scopes }.
scopeLabelsobjectFine scope → { he, en }.

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).

PreviousReactivate a business NextShare a business with a person
On this page
Path parametersResponse
GET /businesses/{bid}/access 
curl -X GET "$BASE/businesses/$BID/access" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/access`, {
  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}/access",
    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.