List services due
const url = 'https://example.com/service-schedules?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&typeId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&planId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&due=overdue&month=2027-03&limit=50&offset=0';const options = { method: 'GET', headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/service-schedules?customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&typeId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&planId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&due=overdue&month=2027-03&limit=50&offset=0' \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token>Every service due across every customer: one row for each plan on each piece of equipment, soonest first. A tracked cylinder is at the customer holding it, at that customer’s first address. booking is the open order it is already on, with its round. q finds part of the customer’s name, the item type, a serial number or an address. Paged with limit and offset; total counts every match.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
UUID v7
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
Overdue: past its date, or for a plan due within a month, past the end of its month. thisMonth: due by the end of this month and not overdue. next3Months: due by the end of the month after next and not overdue.
Overdue: past its date, or for a plan due within a month, past the end of its month. thisMonth: due by the end of this month and not overdue. next3Months: due by the end of the month after next and not overdue.
Example
2027-03Responses
Section titled “Responses”Services due, soonest first
object
object
UUID v7
object
UUID v7
object
UUID v7
object
UUID v7
UUID v7
object
UUID v7
object
UUID v7
object
UUID v7
object
object
UUID v7
UUID v7
Day: due on the date. month: due within the month; the date held is the 1st of the month.
object
object
Not_in: the customer was not in. item_missing: the item was not there. failed: it failed the service. other: said in the note.
UUID v7
UUID v7
Day: due on the date. month: due within the month; the date held is the 1st of the month.
object
UUID v7
UUID v7
Example
{ "items": [ { "scheduleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "customer": { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }, "item": { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "type": { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }, "kind": "customer", "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "deliveryAddress": { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }, "asset": { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }, "product": { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }, "installedOn": "2026-03-01", "schedules": [ { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "planId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "dueRule": "day", "nextDueOn": "2026-03-01", "lastDoneOn": "2026-03-01", "changes": [ { "from": "2026-03-01", "to": "2026-03-01" } ], "notDone": { "on": "2026-03-01", "reason": "not_in", "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } } ] }, "planId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "dueRule": "day", "nextDueOn": "2026-03-01", "lastDoneOn": "2026-03-01", "booking": { "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "wantedOn": "2026-03-01", "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } } ]}Not signed in
object
Example
{ "error": "not_found", "message": "Customer not found"}Not an owner or admin, missing scope, or the plan does not open Equipment servicing
object
Example
{ "error": "not_found", "message": "Customer not found"}Not found, or Equipment servicing is not available to this business
object
Example
{ "error": "not_found", "message": "Customer not found"}Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up
object
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
object
object
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}