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

List quotes

GET /businesses/{bid}/quotes

Requires the documents scope.

Path parameters

NameTypeDescription
bidstringrequiredBusiness id, from POST /businesses.

Query parameters

NameTypeDescription
statusstringexpired is derived (sent, past its validity), not a stored value. One of: draft, sent, expired, accepted, declined, cancelled.
partyIdstring
qstringCustomer name, title, or the quote number.
fromstring
tostring
takeintegerDefault 200.
skipintegerDefault 0.
countsstringAdd per-state totals over the same filters. One of: 1.

Response

200: { "ok": true, … }

FieldTypeDescription
okbooleanrequired
quotesarray of Quoterequired

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

PreviousEmail the document link NextCreate a quote
On this page
Path parametersQuery parametersResponse
GET /businesses/{bid}/quotes 
curl -X GET "$BASE/businesses/$BID/quotes?status=&partyId=&q=" \
  -H "X-Api-Key: $KEY"
const res = await fetch(`${BASE}/businesses/${BID}/quotes`, {
  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}/quotes",
    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.