GET/businesses/{bid}/appointments

List appointments in a window

GET /businesses/{bid}/appointments

Requires the businesses scope.

Oldest first, each with its billing state and overlaps. from and to are required and at most 62 days apart (a year with partyId), except with unbilled=1, which lists the done visits waiting for a document and looks back 90 days when no window is sent.

Path parameters

Name	Type		Description
`bid`	string	required	Business id, from `POST /businesses`.

Query parameters

Name	Type	Description
`from`	string
`to`	string
`partyId`	string
`status`	string	One or several, comma-separated: scheduled, done, cancelled, no_show.
`unbilled`	string	One of: `1`.

Response

200: { "ok": true, … }

Field	Type
`ok`	boolean	required
`from`	string
`to`	string
`appointments`	array of Appointment	required

Errors: 400, 401, 403, 404, 409, 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).

const res = await fetch(`${BASE}/businesses/${BID}/appointments`, { method: 'GET', headers: { 'X-Api-Key': KEY, }, }) const data = await res.json() if (!data.ok) throw new Error(data.reason)