List bookings
Appointments sorted by start time. Time staff blocked off for a break is not a booking and is left out.
Keys: a key that may read. A public key gets 403.
apiKeyAuthorizationBearer wo_live_...A key from the shop's admin. Secret keys start with wo_live_, public keys with wo_pub_.
cursor?stringnext_cursor from the page before. Leave out for the first page.
length <= 200limit?integerHow many objects a page holds.
1 <= value <= 10025order?stringThe list sorts on starts_at, then the id. desc puts the latest start first.
"desc""asc""desc"customer_id?stringOnly this customer's.
uuidstaff_id?stringOnly this staff member's.
uuidstarts_after?stringOnly bookings that start at or after this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.
date-timestarts_before?stringOnly bookings that start before this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.
date-timestatus?stringOnly bookings in this state.
"confirmed""completed""cancelled""no_show"updated_after?stringOnly bookings changed after this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.
date-timeThe request worked.
application/json- response
data*array<>has_more*booleanWhether another page follows this one.
next_cursor*|nullobject*stringcurl 'https://api.weerom.com/v1/bookings'{ "data": [ { "cancel_reason": "", "cancelled_at": null, "code": "UEAMEFC9", "comments": "", "created_at": "2026-11-18T14:02:11.000Z", "currency": "EUR", "customer": { "email": "[email protected]", "id": "5f0c9d3a-7b2e-4c61-8a4d-9e1f3b6c2d75", "name": "Lotte Peeters", "phone": "+32470123456" }, "discount_percent": 0, "ends_at": "2026-11-21T10:15:00.000Z", "id": "0b6f2a4e-5d1c-4f7a-9a3e-2c8d1e6f4b90", "list_price_cents": 4000, "locale": "nl", "minutes": 45, "object": "booking", "payment": { "amount_cents": 4000, "method": "bancontact", "paid_at": "2026-11-21T10:12:40.000Z", "tip_cents": 200 }, "price_cents": 4000, "service": { "id": "c2a41f6e-8d3b-4e97-b5a0-1f7c9e2d4a68", "name": "Knippen en baard" }, "source": "web", "staff_id": "8e1d5b7c-3a9f-4d20-b6c4-7a2e0f9d1c53", "starts_at": "2026-11-21T09:30:00.000Z", "status": "completed", "updated_at": "2026-11-21T10:12:40.000Z" } ], "has_more": false, "next_cursor": null, "object": "list"}Details
Keys
Read keyWrite key
Any other kind of key answers 403 key_not_allowed.
Sort
By starts_at, then by id. order=desc, the default, puts the latest start first, so the furthest booking in the future comes first. order=asc starts with the earliest.
Filters
starts_afterincludes a booking that starts at that exact moment.starts_beforeleaves out a booking that starts at that exact moment. The two together cover a day without overlap:starts_after=2026-11-21T00:00:00+01:00&starts_before=2026-11-22T00:00:00+01:00.updated_afterleaves out a booking changed at that exact moment.status,staff_idandcustomer_idmatch exactly. Filters combine with AND.
What it does
- Time staff blocked off for a break is not a booking and never shows up.
updated_afteronly filters. The list keeps its sort bystarts_at, so a sync takes the highestupdated_atfrom every page. See Pagination.
When a field is null
cancelled_atisnulluntil the booking is cancelled.paymentisnulluntil staff note a payment.service.idisnullwhen the booking is not linked to a service record. The name written on the booking still shows.customer.idisnullwhen the shop erased the customer's record. The booking keeps the name, email and phone written on it.customer.emailisnullwhen the booking holds no email. Staff may book without one.customer.phoneisnullwhen the booking holds no phone number.
Errors
Besides 401 for a missing, unknown or removed key, 403 plan_required, 429 rate_limited and 500 internal_error, which every endpoint can answer. Errors has all of them.
| Status | code | When | What to do |
|---|---|---|---|
| 400 | invalid_request | A parameter is malformed or unknown, a date has no time and offset, an id is not a UUID, or the cursor is not one the API gave out. | Fix the parameter param names. |
Change a customer PATCH
Changes a customer's name or blocks them. Send only the fields to change. There is no endpoint that makes a customer: making a booking makes its customer. **Keys:** a key that may read and change. Any other key gets 403.
Make a booking POST
Books a free time for a customer and answers with the booking. The shop's rules apply as on its own booking form: opening hours, how far ahead a booking may be made, a paused form, a blocked customer. The customer gets the shop's confirmation mail and staff get their usual notice. A public key books as a visitor, with a visitor's limits per address and per person, and may not send `as`. A write key may send `as: staff` to book like staff typing a walk-in into the agenda, which skips the lead time and the paused form. Send an `Idempotency-Key` so a retry after a timeout cannot book twice. **Keys:** a public key, or a key that may read and change. A key that may only read gets 403.