API reference
All endpoints of version 1. Click a resource for its fields, filters and examples.
$QUILO_URL/api/v1Authorization: Bearer qk_…Machine-readable: openapi.json (OpenAPI 3.1). Import it into Postman, Insomnia or a code generator.
Me
/meWho this key acts asClients
People and companies who buy from you, with contact details, preferences (ring size, metal, stones, style) and dates.
/clientsList clients/clientsCreate a client/clients/{id}Get a client/clients/{id}Change a client/clients/{id}Delete a clientSales
What clients bought: date, receipt number, items and total. A receipt number is unique per brand.
/salesList sales/salesCreate a sale/sales/{id}Get a sale/sales/{id}Change a sale/sales/{id}Delete a saleCustom orders
Made-to-order pieces moving through stages from inquiry to won or lost.
/custom-ordersList custom orders/custom-ordersCreate a custom order/custom-orders/{id}Get a custom order/custom-orders/{id}Change a custom order/custom-orders/{id}Delete a custom orderAppointments
Visits, calls and fittings. Appointments created through the API are marked with source "api".
/appointmentsList appointments/appointmentsCreate a appointment/appointments/{id}Get a appointment/appointments/{id}Change a appointment/appointments/{id}Delete a appointmentTasks & follow-ups
To-dos and follow-ups, optionally linked to a client.
/tasksList tasks & follow-ups/tasksCreate a task/tasks/{id}Get a task/tasks/{id}Change a task/tasks/{id}Delete a taskInvoices
Invoices with Swiss QR-bill reference (read only in v1). GET /invoices/{id} includes the lines.
/invoicesList invoices/invoices/{id}Get a invoiceBrands
The brands (shops, labels) of the company that you can access. Use their IDs as brand_id.
/brandsList brands/brands/{id}Get a brandcurl "$QUILO_URL/api/v1/openapi.json" -o quilo-openapi.json