Download services due as CSV
const url = 'https://example.com/service-schedules.csv?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.csv?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. Every match, with the same filters; limit and offset are ignored. UTF-8 with a byte order mark and CRLF line ends. Any text cell a spreadsheet would run as a formula has a ' put in front.
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”The CSV file
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" } ]}