{"schemaVersion":1,"platform":{"name":"Bookatu","url":"https://bookatu.com","summary":"Online booking and scheduling software for salons, spas, nail and beauty studios, barbers, personal trainers, coaches, studios, photographers and restaurants. Each business gets a branded booking page, a calendar, automatic reminders, deposits and no-show protection, client records, marketing tools, a public REST API and an MCP server for AI agents. Flat subscription, 0% commission on bookings."},"docs":{"developers":"https://bookatu.com/en-nz/developers","openapi":"https://bookatu.com/api/openapi.json","llms":"https://bookatu.com/llms.txt","llmsFull":"https://bookatu.com/llms-full.txt","help":"https://bookatu.com/en-nz/help","faq":"https://bookatu.com/en-nz/faq"},"api":{"style":"REST over HTTPS, JSON responses; errors are { ok: false, error }; the customer booking-management endpoints under /booking/{id} return { error }","baseUrl":"https://bookatu.com/api/v1/{slug}","corsOpen":true,"auth":{"public":"business, services, staff, availability and book need no authentication","bookingId":"the endpoints under /booking/{id} take no API key: the booking's manage key (the k on the client's manage link, manageKey from POST /book, or X-Manage-Key) is the capability, is only ever given to the person who booked, and is scoped to the business in the URL; the appointment id alone reads a read-only status. They send no CORS wildcard and are rate limited per IP","apiKey":{"headerForms":["Authorization: Bearer bk_live_YOUR_KEY","X-Api-Key: bk_live_YOUR_KEY"],"keyPrefix":"bk_live_","scopes":["read-only","read-write"],"keyScopes":["bookings:read","bookings:write","availability:read","catalog:read","catalog:write","staff:read","customers:read","reports:read","content:read","content:write","webhooks:read","webhooks:write","checkout:read","checkout:write","audit:read","customers:write","customers:manage","pos:write","marketing:write","enquiries:write","bookings:override","messages:read","messages:write"],"optInScopes":["checkout:read","checkout:write","audit:read","customers:write","customers:manage","pos:write","marketing:write","enquiries:write","bookings:override","messages:read","messages:write"],"endpointScopes":{"GET /customers":"customers:read","GET /appointments":"bookings:read","POST /appointments":"bookings:write","GET /appointments/{id}":"bookings:read","POST /appointments/{id}/cancel":"bookings:write","GET /appointments/{id}/checkout":"checkout:read","POST /appointments/{id}/checkout":"checkout:write","POST /appointments/{id}/deposit-request":"bookings:write","POST /appointments/{id}/deposit-request/cancel":"bookings:write","GET /booking-requests":"bookings:read","POST /booking-requests/{id}/accept":"bookings:write","POST /booking-requests/{id}/decline":"bookings:write","GET /class-sessions":"bookings:read","GET /class-sessions/{id}/roster":"bookings:read","POST /class-sessions/{id}/roster":"bookings:write","POST /class-sessions/{id}/roster/{enrolmentId}/cancel":"bookings:write","POST /class-sessions/{id}/roster/{enrolmentId}/attendance":"bookings:write","GET /reports/earnings":"reports:read","GET /reports/tips":"reports:read","GET /reports/deposits":"reports:read","GET /audit-log":"audit:read","POST /visits":"bookings:write","GET /visits/{id}":"bookings:read","POST /visits/{id}/reschedule":"bookings:write","POST /visits/{id}/cancel":"bookings:write","POST /appointments/{id}/tags":"bookings:write","DELETE /appointments/{id}/tags/{tagId}":"bookings:write","POST /customers/{id}/tags":"customers:write","DELETE /customers/{id}/tags/{tagId}":"customers:write","PUT /walk-in/manual":"bookings:write","DELETE /walk-in/manual":"bookings:write","GET /sandbox/outbox":"customers:read","GET /sandbox/payments":"reports:read","POST /sandbox/simulate/{event}":"bookings:write","POST /enquiries":"enquiries:write","GET /enquiries/trips":"enquiries:write","POST /appointments/{id}/reschedule":"bookings:write","GET /products":"catalog:read","POST /products":"catalog:write","PATCH /products/{id}":"catalog:write","POST /products/{id}/receive":"catalog:write","POST /services":"catalog:write","PATCH /services/{id}":"catalog:write","GET /blog-posts":"content:read","GET /blog-posts/{id}":"content:read","POST /blog-posts":"content:write","PATCH /blog-posts/{id}":"content:write","POST /blog-posts/{id}/publish":"content:write","POST /blog-posts/{id}/unpublish":"content:write","GET /forms":"content:read","GET /forms/{id}":"content:read","POST /forms":"content:write","PATCH /forms/{id}":"content:write","POST /forms/{id}/services":"content:write","DELETE /forms/{id}/services/{serviceId}":"content:write","GET /forms/{id}/responses":"customers:read","GET /campaigns":"content:read","GET /campaigns/{id}":"content:read","POST /campaigns":"content:write","GET /reports":"reports:read","GET /reports/findings":"reports:read","GET /reports/capacity":"reports:read","GET /webhooks":"webhooks:read","POST /webhooks":"webhooks:write","POST /webhooks/{id}/disable":"webhooks:write","GET /whoami":null,"GET /search":null,"GET /how-do-i":null,"GET /open":null,"GET /help":null,"GET /approvals/{id}":null,"POST /service-categories/rename":"catalog:write","POST /stock-deliveries":"catalog:write","POST /products/{id}/sales":"pos:write","POST /time-blocks":"bookings:write","POST /appointments/{id}/notes":"bookings:write","POST /customers":"customers:manage","PATCH /customers/{id}":"customers:manage","POST /customers/{id}/notes":"customers:manage","POST /announcements":"marketing:write","GET /client-messages":"messages:read","PATCH /client-messages":"messages:write","GET /client-messages/held":"messages:read","POST /client-messages/held/{id}/send":"messages:write","GET /enquiries/held":"customers:read","POST /enquiries/held/{id}/release":"enquiries:write"},"issuedAt":"the business's admin dashboard"},"keyProtectedRequiresAddon":true},"endpoints":[{"id":"business","method":"GET","path":"/api/v1/{slug}/business","auth":"none","summary":"Business profile + opening hours"},{"id":"services","method":"GET","path":"/api/v1/{slug}/services","auth":"none","summary":"List active, online-bookable services"},{"id":"staff","method":"GET","path":"/api/v1/{slug}/staff","auth":"none","summary":"List bookable team members"},{"id":"availability","method":"GET","path":"/api/v1/{slug}/availability","auth":"none","summary":"Open slots for a service"},{"id":"book","method":"POST","path":"/api/v1/{slug}/book","auth":"none","summary":"Create a booking (online source)"},{"id":"booking-get","method":"GET","path":"/api/v1/{slug}/booking/{id}","auth":"bookingId","summary":"Read one booking (the customer's own)"},{"id":"booking-reschedule-availability","method":"GET","path":"/api/v1/{slug}/booking/{id}/availability","auth":"bookingId","summary":"Open slots for MOVING this booking"},{"id":"booking-reschedule","method":"POST","path":"/api/v1/{slug}/booking/{id}/reschedule","auth":"bookingId","summary":"Move a booking to a new time"},{"id":"booking-cancel","method":"POST","path":"/api/v1/{slug}/booking/{id}/cancel","auth":"bookingId","summary":"Cancel a booking (the customer's own)"},{"id":"customers","method":"GET","path":"/api/v1/{slug}/customers","auth":"apiKey","summary":"List customers"},{"id":"appointments","method":"GET","path":"/api/v1/{slug}/appointments","auth":"apiKey","summary":"List appointments"},{"id":"services-get","method":"GET","path":"/api/v1/{slug}/services/{id}","auth":"none","summary":"Get one service"},{"id":"appointments-get","method":"GET","path":"/api/v1/{slug}/appointments/{id}","auth":"apiKey","summary":"Get one appointment"},{"id":"appointments-create","method":"POST","path":"/api/v1/{slug}/appointments","auth":"apiKey","summary":"Create a booking (admin source)"},{"id":"appointments-cancel","method":"POST","path":"/api/v1/{slug}/appointments/{id}/cancel","auth":"apiKey","summary":"Cancel a booking"},{"id":"appointments-checkout-get","method":"GET","path":"/api/v1/{slug}/appointments/{id}/checkout","auth":"apiKey","summary":"What a booking comes to at checkout (MGR hand-off)"},{"id":"appointments-checkout-post","method":"POST","path":"/api/v1/{slug}/appointments/{id}/checkout","auth":"apiKey","summary":"Post an outside sale back: the booking is checked out (MGR hand-off)"},{"id":"appointments-deposit-request","method":"POST","path":"/api/v1/{slug}/appointments/{id}/deposit-request","auth":"apiKey","summary":"Send the deposit pay link again"},{"id":"appointments-deposit-request-cancel","method":"POST","path":"/api/v1/{slug}/appointments/{id}/deposit-request/cancel","auth":"apiKey","summary":"Stop asking for the deposit"},{"id":"booking-requests","method":"GET","path":"/api/v1/{slug}/booking-requests","auth":"apiKey","summary":"List booking requests waiting for an answer"},{"id":"booking-requests-accept","method":"POST","path":"/api/v1/{slug}/booking-requests/{id}/accept","auth":"apiKey","summary":"Accept a booking request"},{"id":"booking-requests-decline","method":"POST","path":"/api/v1/{slug}/booking-requests/{id}/decline","auth":"apiKey","summary":"Decline a booking request"},{"id":"class-sessions","method":"GET","path":"/api/v1/{slug}/class-sessions","auth":"apiKey","summary":"List class sessions"},{"id":"class-sessions-roster","method":"GET","path":"/api/v1/{slug}/class-sessions/{id}/roster","auth":"apiKey","summary":"Who holds a place on a class session"},{"id":"class-sessions-roster-add","method":"POST","path":"/api/v1/{slug}/class-sessions/{id}/roster","auth":"apiKey","summary":"Put a phone or walk-in client on a class session"},{"id":"class-sessions-roster-cancel","method":"POST","path":"/api/v1/{slug}/class-sessions/{id}/roster/{enrolmentId}/cancel","auth":"apiKey","summary":"Cancel one person's place on a class session"},{"id":"class-sessions-roster-attendance","method":"POST","path":"/api/v1/{slug}/class-sessions/{id}/roster/{enrolmentId}/attendance","auth":"apiKey","summary":"Mark who came to a class session"},{"id":"reports-earnings","method":"GET","path":"/api/v1/{slug}/reports/earnings","auth":"apiKey","summary":"Staff earnings and commission"},{"id":"reports-tips","method":"GET","path":"/api/v1/{slug}/reports/tips","auth":"apiKey","summary":"Tips"},{"id":"reports-deposits","method":"GET","path":"/api/v1/{slug}/reports/deposits","auth":"apiKey","summary":"Deposit reconciliation"},{"id":"audit-log","method":"GET","path":"/api/v1/{slug}/audit-log","auth":"apiKey","summary":"The audit log"},{"id":"customer-tags-add","method":"POST","path":"/api/v1/{slug}/customers/{id}/tags","auth":"apiKey","summary":"Tag a client"},{"id":"customer-tags-remove","method":"DELETE","path":"/api/v1/{slug}/customers/{id}/tags/{tagId}","auth":"apiKey","summary":"Untag a client"},{"id":"appointment-tags-add","method":"POST","path":"/api/v1/{slug}/appointments/{id}/tags","auth":"apiKey","summary":"Tag a booking"},{"id":"appointment-tags-remove","method":"DELETE","path":"/api/v1/{slug}/appointments/{id}/tags/{tagId}","auth":"apiKey","summary":"Untag a booking"},{"id":"sandbox-outbox","method":"GET","path":"/api/v1/{slug}/sandbox/outbox","auth":"apiKey","summary":"The test outbox (sandbox only)"},{"id":"sandbox-simulate","method":"POST","path":"/api/v1/{slug}/sandbox/simulate/{event}","auth":"apiKey","summary":"Simulate an event (sandbox only)"},{"id":"sandbox-payments","method":"GET","path":"/api/v1/{slug}/sandbox/payments","auth":"apiKey","summary":"The test payments (sandbox only)"},{"id":"tool-reschedule-booking","method":"POST","path":"/api/v1/{slug}/appointments/{id}/reschedule","auth":"apiKey","summary":"Move a booking"},{"id":"tool-list-products","method":"GET","path":"/api/v1/{slug}/products","auth":"apiKey","summary":"List products"},{"id":"tool-create-product","method":"POST","path":"/api/v1/{slug}/products","auth":"apiKey","summary":"Add a product"},{"id":"tool-update-product","method":"PATCH","path":"/api/v1/{slug}/products/{id}","auth":"apiKey","summary":"Update a product"},{"id":"tool-receive-stock","method":"POST","path":"/api/v1/{slug}/products/{id}/receive","auth":"apiKey","summary":"Receive stock"},{"id":"tool-create-service","method":"POST","path":"/api/v1/{slug}/services","auth":"apiKey","summary":"Add a service"},{"id":"tool-update-service","method":"PATCH","path":"/api/v1/{slug}/services/{id}","auth":"apiKey","summary":"Update a service"},{"id":"tool-blog-list-posts","method":"GET","path":"/api/v1/{slug}/blog-posts","auth":"apiKey","summary":"List blog posts"},{"id":"tool-blog-get-post","method":"GET","path":"/api/v1/{slug}/blog-posts/{id}","auth":"apiKey","summary":"Read a blog post"},{"id":"tool-blog-create-post","method":"POST","path":"/api/v1/{slug}/blog-posts","auth":"apiKey","summary":"Write a blog post"},{"id":"tool-blog-update-post","method":"PATCH","path":"/api/v1/{slug}/blog-posts/{id}","auth":"apiKey","summary":"Update a blog post"},{"id":"tool-blog-publish-post","method":"POST","path":"/api/v1/{slug}/blog-posts/{id}/publish","auth":"apiKey","summary":"Publish a blog post"},{"id":"tool-blog-unpublish-post","method":"POST","path":"/api/v1/{slug}/blog-posts/{id}/unpublish","auth":"apiKey","summary":"Unpublish a blog post"},{"id":"tool-forms-list","method":"GET","path":"/api/v1/{slug}/forms","auth":"apiKey","summary":"List forms"},{"id":"tool-forms-get","method":"GET","path":"/api/v1/{slug}/forms/{id}","auth":"apiKey","summary":"Read a form"},{"id":"tool-forms-create","method":"POST","path":"/api/v1/{slug}/forms","auth":"apiKey","summary":"Create a form"},{"id":"tool-forms-update","method":"PATCH","path":"/api/v1/{slug}/forms/{id}","auth":"apiKey","summary":"Update a form"},{"id":"tool-forms-attach-to-service","method":"POST","path":"/api/v1/{slug}/forms/{id}/services","auth":"apiKey","summary":"Require a form for a service"},{"id":"tool-forms-detach-from-service","method":"DELETE","path":"/api/v1/{slug}/forms/{id}/services/{serviceId}","auth":"apiKey","summary":"Stop requiring a form for a service"},{"id":"tool-forms-list-responses","method":"GET","path":"/api/v1/{slug}/forms/{id}/responses","auth":"apiKey","summary":"List form responses"},{"id":"tool-campaigns-list","method":"GET","path":"/api/v1/{slug}/campaigns","auth":"apiKey","summary":"List email campaigns"},{"id":"tool-campaigns-get","method":"GET","path":"/api/v1/{slug}/campaigns/{id}","auth":"apiKey","summary":"Read an email campaign"},{"id":"tool-campaigns-create-draft","method":"POST","path":"/api/v1/{slug}/campaigns","auth":"apiKey","summary":"Draft an email campaign"},{"id":"tool-get-report","method":"GET","path":"/api/v1/{slug}/reports","auth":"apiKey","summary":"Business report"},{"id":"tool-get-findings","method":"GET","path":"/api/v1/{slug}/reports/findings","auth":"apiKey","summary":"Findings from the numbers"},{"id":"tool-get-capacity","method":"GET","path":"/api/v1/{slug}/reports/capacity","auth":"apiKey","summary":"Chair time by hour"},{"id":"tool-webhooks-list","method":"GET","path":"/api/v1/{slug}/webhooks","auth":"apiKey","summary":"List webhooks"},{"id":"tool-webhooks-create","method":"POST","path":"/api/v1/{slug}/webhooks","auth":"apiKey","summary":"Add a webhook"},{"id":"tool-webhooks-disable","method":"POST","path":"/api/v1/{slug}/webhooks/{id}/disable","auth":"apiKey","summary":"Switch off a webhook"},{"id":"tool-whoami","method":"GET","path":"/api/v1/{slug}/whoami","auth":"apiKey","summary":"Who am I working for"},{"id":"tool-search","method":"GET","path":"/api/v1/{slug}/search","auth":"apiKey","summary":"Search the business"},{"id":"tool-how-do-i","method":"GET","path":"/api/v1/{slug}/how-do-i","auth":"apiKey","summary":"How do I"},{"id":"tool-open-in-bookatu","method":"GET","path":"/api/v1/{slug}/open","auth":"apiKey","summary":"Open in Bookatu"},{"id":"tool-get-help","method":"GET","path":"/api/v1/{slug}/help","auth":"apiKey","summary":"Help centre"},{"id":"tool-get-approval","method":"GET","path":"/api/v1/{slug}/approvals/{id}","auth":"apiKey","summary":"Where an approval has got to"},{"id":"tool-rename-service-category","method":"POST","path":"/api/v1/{slug}/service-categories/rename","auth":"apiKey","summary":"Rename a service category"},{"id":"tool-bulk-receive-stock","method":"POST","path":"/api/v1/{slug}/stock-deliveries","auth":"apiKey","summary":"Receive a delivery"},{"id":"tool-sell-product","method":"POST","path":"/api/v1/{slug}/products/{id}/sales","auth":"apiKey","summary":"Record an in-person sale"},{"id":"tool-block-time","method":"POST","path":"/api/v1/{slug}/time-blocks","auth":"apiKey","summary":"Block time"},{"id":"tool-add-booking-note","method":"POST","path":"/api/v1/{slug}/appointments/{id}/notes","auth":"apiKey","summary":"Add a booking note"},{"id":"tool-create-customer","method":"POST","path":"/api/v1/{slug}/customers","auth":"apiKey","summary":"Add a client"},{"id":"tool-update-customer","method":"PATCH","path":"/api/v1/{slug}/customers/{id}","auth":"apiKey","summary":"Update a client"},{"id":"tool-add-customer-note","method":"POST","path":"/api/v1/{slug}/customers/{id}/notes","auth":"apiKey","summary":"Add a client note"},{"id":"tool-create-announcement","method":"POST","path":"/api/v1/{slug}/announcements","auth":"apiKey","summary":"Post an announcement"},{"id":"tool-get-client-messages","method":"GET","path":"/api/v1/{slug}/client-messages","auth":"apiKey","summary":"Which messages clients get"},{"id":"tool-set-client-messages","method":"PATCH","path":"/api/v1/{slug}/client-messages","auth":"apiKey","summary":"Change which messages clients get"},{"id":"tool-list-held-client-messages","method":"GET","path":"/api/v1/{slug}/client-messages/held","auth":"apiKey","summary":"Messages held by your settings"},{"id":"tool-send-held-client-message","method":"POST","path":"/api/v1/{slug}/client-messages/held/{id}/send","auth":"apiKey","summary":"Send a held client message"},{"id":"tool-list-held-enquiries","method":"GET","path":"/api/v1/{slug}/enquiries/held","auth":"apiKey","summary":"Website enquiries held for you"},{"id":"tool-release-held-enquiry","method":"POST","path":"/api/v1/{slug}/enquiries/held/{id}/release","auth":"apiKey","summary":"Move a held enquiry into Leads"},{"id":"walk-in","method":"GET","path":"/api/v1/{slug}/walk-in","auth":"none","summary":"Walk-in wait now"},{"id":"walk-in-manual-set","method":"PUT","path":"/api/v1/{slug}/walk-in/manual","auth":"apiKey","summary":"Set the walk-in wait by hand"},{"id":"walk-in-manual-clear","method":"DELETE","path":"/api/v1/{slug}/walk-in/manual","auth":"apiKey","summary":"Back to the automatic walk-in wait"},{"id":"enquiries-create","method":"POST","path":"/api/v1/{slug}/enquiries","auth":"apiKey","summary":"Send an enquiry from your website form"},{"id":"enquiries-trips","method":"GET","path":"/api/v1/{slug}/enquiries/trips","auth":"apiKey","summary":"List the trip codes for enquiries"},{"id":"agent-business","method":"GET","path":"/api/v1/{slug}/agent/business","auth":"none","summary":"Business details and policies, for an assistant"},{"id":"agent-services","method":"GET","path":"/api/v1/{slug}/agent/services","auth":"none","summary":"Services and prices, for an assistant"},{"id":"agent-availability","method":"GET","path":"/api/v1/{slug}/agent/availability","auth":"none","summary":"Open times, for an assistant"},{"id":"agent-holds-create","method":"POST","path":"/api/v1/{slug}/agent/holds","auth":"none","summary":"Hold a time and email the person to confirm it"},{"id":"agent-hold-status","method":"GET","path":"/api/v1/{slug}/agent/holds/{holdId}","auth":"none","summary":"Where a held time stands"},{"id":"agent-hold-confirm","method":"POST","path":"/api/v1/{slug}/agent/holds/{holdId}/confirm","auth":"none","summary":"Confirm a held time with the person's code"},{"id":"agent-hold-release","method":"POST","path":"/api/v1/{slug}/agent/holds/{holdId}/release","auth":"none","summary":"Release a held time"},{"id":"visits-availability","method":"GET","path":"/api/v1/{slug}/visits/availability","auth":"none","summary":"Open starts for a visit of several services"},{"id":"visits-book","method":"POST","path":"/api/v1/{slug}/visits/book","auth":"none","summary":"Book a visit of several services (online source)"},{"id":"visits-create","method":"POST","path":"/api/v1/{slug}/visits","auth":"apiKey","summary":"Book a visit of several services (the team's)"},{"id":"visits-get","method":"GET","path":"/api/v1/{slug}/visits/{id}","auth":"apiKey","summary":"Get one visit"},{"id":"visits-reschedule","method":"POST","path":"/api/v1/{slug}/visits/{id}/reschedule","auth":"apiKey","summary":"Move a whole visit"},{"id":"visits-cancel","method":"POST","path":"/api/v1/{slug}/visits/{id}/cancel","auth":"apiKey","summary":"Cancel a whole visit"}]},"mcp":{"endpoint":"https://bookatu.com/api/mcp","protocol":"MCP (JSON-RPC 2.0) over HTTPS POST","auth":{"modes":["Authorization: Bearer bk_live_YOUR_KEY","X-Api-Key: bk_live_YOUR_KEY"],"oauth":{"summary":"OAuth 2.1 with PKCE for MCP clients (Claude's custom connector among them): RFC 8414 + RFC 9728 discovery, RFC 7591 dynamic client registration, owner-consented, org-scoped tokens.","authorizationServerMetadata":"https://bookatu.com/.well-known/oauth-authorization-server","protectedResourceMetadata":"https://bookatu.com/.well-known/oauth-protected-resource"},"orgScoped":true,"scopes":["bookings:read","bookings:write","availability:read","catalog:read","catalog:write","staff:read","customers:read","reports:read","content:read","content:write","webhooks:read","webhooks:write","checkout:read","checkout:write","audit:read","customers:write","customers:manage","pos:write","marketing:write","enquiries:write","bookings:override","messages:read","messages:write"],"accessLevels":["read-only","read-write"],"toolScopes":{"list_services":"catalog:read","get_availability":"availability:read","create_booking":"bookings:write","list_customers":"customers:read","list_appointments":"bookings:read","list_staff":"staff:read","reschedule_booking":"bookings:write","cancel_booking":"bookings:write","list_products":"catalog:read","create_product":"catalog:write","update_product":"catalog:write","receive_stock":"catalog:write","create_service":"catalog:write","update_service":"catalog:write","blog_list_posts":"content:read","blog_get_post":"content:read","blog_create_post":"content:write","blog_update_post":"content:write","blog_publish_post":"content:write","blog_unpublish_post":"content:write","forms_list":"content:read","forms_get":"content:read","forms_create":"content:write","forms_update":"content:write","forms_attach_to_service":"content:write","forms_detach_from_service":"content:write","forms_list_responses":"customers:read","campaigns_list":"content:read","campaigns_get":"content:read","campaigns_create_draft":"content:write","get_report":"reports:read","get_findings":"reports:read","get_capacity":"reports:read","webhooks_list":"webhooks:read","webhooks_create":"webhooks:write","webhooks_disable":"webhooks:write","list_booking_requests":"bookings:read","accept_booking_request":"bookings:write","decline_booking_request":"bookings:write","list_class_sessions":"bookings:read","get_class_roster":"bookings:read","add_class_attendee":"bookings:write","cancel_class_place":"bookings:write","mark_class_attendance":"bookings:write","send_deposit_link":"bookings:write","stop_deposit_request":"bookings:write","get_earnings":"reports:read","get_tips":"reports:read","get_deposit_report":"reports:read","get_audit_log":"audit:read","get_checkout":"checkout:read","get_visit_availability":"availability:read","create_visit":"bookings:write","get_visit":"bookings:read","reschedule_visit":"bookings:write","cancel_visit":"bookings:write","get_business":"catalog:read","get_walk_in_wait":"availability:read","set_walk_in_wait":"bookings:write","clear_walk_in_wait":"bookings:write","whoami":null,"search":null,"how_do_i":null,"open_in_bookatu":null,"get_help":null,"get_approval":null,"rename_service_category":"catalog:write","bulk_receive_stock":"catalog:write","sell_product":"pos:write","block_time":"bookings:write","add_booking_note":"bookings:write","create_customer":"customers:manage","update_customer":"customers:manage","add_customer_note":"customers:manage","create_announcement":"marketing:write","get_client_messages":"messages:read","set_client_messages":"messages:write","list_held_client_messages":"messages:read","send_held_client_message":"messages:write","list_held_enquiries":"customers:read","release_held_enquiry":"enquiries:write"}},"toolCount":81,"toolFamilies":[{"id":"booking","title":"Booking and clients","description":"Services, open slots, bookings, customers and upcoming appointments.","tools":[{"name":"list_services","description":"List all active bookable services, each with the extras offered with it (addOns) at a business that has extras, its combination rules (combinations: onlyWith, neverWith) when it has any, how many people it needs at once (peopleNeeded) when that is more than one, and the kinds of resource it needs at once (resourceKinds) when that is two or more, and the booking questions it asks (questions, in the order asked, as GET /services lists them) at a business that asks any, and how clients meet you for it (meetingType) and the notice a booking of it needs (noticeHours)."},{"name":"get_availability","description":"Get open slots for a service over a date range (max 60 days), with durationMin, how long each slot is. Optional addOnIds asks for the longer booking when an extra adds its time. Each slot also has local, its start with the offset in force on its own date on the one timeZone the answer names, and clientLocal on clientTimeZone when that is given. A slot a surcharge covers (a public holiday or a busy time the business charges more for) also has priceCents, surcharges (label, amountType, amount, amountCents) and totalCents, the price at that time, to show the client before they book; other slots have none of these. A from or to that is a date that does not exist, such as 30 February, or one too far away, is refused as Invalid params (-32602) in the words GET /availability uses (\"Use a real date in YYYY-MM-DD format.\", \"Ask for dates in the next few years.\")."},{"name":"create_booking","description":"Book an appointment for a customer; returns a ref. A service that takes a deposit is refused with DEPOSIT_NEEDS_BOOKING_PAGE and bookingPageUrl (the business's booking page, where the customer books it and pays the deposit), and nothing is booked. Optional repeat ({ everyDays | monthly, visits }) books a series, each repeat checked and a clash left out and listed. Optional marketingConsent ({ source, wording }) only when the customer agreed to marketing email; without it they are not opted in. Optional addOnIds adds extras, refused with the reason when the service does not take one. Optional clientTimeZone (a place's IANA zone) is kept on the booking. Optional answers ({ questionId: answer }) answers the business's booking questions (list_services lists them on each service), read exactly as answers on POST /book: a required question left out is refused with ANSWERS_REQUIRED and missingQuestionIds, an answer that cannot be read with ANSWERS_INVALID and invalidAnswers, and nothing is booked; ask the person and send their answers, or send them to bookingPageUrl. The answers are never echoed back or sent in a webhook. The time is startAt with its offset, or localTime (\"2026-11-04T09:00\") on the business's clock or a named timeZone; a time with no offset is refused with TIME_NEEDS_OFFSET, one the clocks skip with TIME_DOES_NOT_EXIST (and nextValid), one they show twice with TIME_AMBIGUOUS (and both candidates). The answer's when is the booked start as a When, on the business's clock and, when their zone is known, the client's. Optional asStaff: true books as the team does, for the business's own assistant through a key or app whose maker may Edit the calendar: a service that takes a deposit is booked and never held for one, and a time that is not free is still refused. Requires a read-write key."},{"name":"list_customers","description":"List all customers in the org."},{"name":"list_appointments","description":"List upcoming pending and confirmed appointments. Returns each booking's id for reschedule_booking and cancel_booking, its visitId when it is one service of a visit (get_visit), additionalStaffIds when two or more of the team do it at once, and resources (every room, chair or machine it holds, { id, name, kind }) when its service needs two or more kinds of resource at once. A booking whose client asked to swap out of a late cancellation (Quick swap) has swap: { status (requested, claimed, withdrawn or expired), requestedAt, cutoffAt, closedAt, claimedAppointmentId }. Times also come as timeZone plus start and end When objects, with the offset in force at each instant."},{"name":"list_staff","description":"List the bookable team members: id, name, title, active and bookable."},{"name":"reschedule_booking","description":"Move a booking to a new time, and optionally to a different team member. The new time is re-checked exactly as a client's own reschedule is, so a time that is not free is refused rather than double-booked. The time is startAt with its offset, or localTime (\"2026-11-04T09:00\") on the business's clock or a named timeZone; a time with no offset is refused with TIME_NEEDS_OFFSET, one the clocks skip with TIME_DOES_NOT_EXIST (and nextValid), one they show twice with TIME_AMBIGUOUS (and both candidates). The answer's when is the booked start as a When, on the business's clock and, when their zone is known, the client's. Requires a read-write key."},{"name":"cancel_booking","description":"Cancel a booking, as the business. The slot goes back on offer and the client is sent no message about it; the reply says whether a paid deposit was kept under the business's notice policy (refundDeposit: true refunds it anyway). Requires a read-write key."},{"name":"create_service","description":"Add a standard bookable service (duration in minutes, prices in dollars), with how clients meet you for it (meetingType) and its own notice to cancel or change (noticeHours) when you send them. A new service is never a trip, so a destination or an itinerary is refused. Requires a read-write key."},{"name":"update_service","description":"Update only the provided fields of a service; null clears meetingType, noticeHours, destination or itinerary. A destination and an itinerary are only for a trip (a service that lasts whole days), never more days than it lasts. Requires a read-write key."},{"name":"list_booking_requests","description":"List the booking requests waiting for the business's answer (a new online booking, or a client's move of a confirmed one), oldest first, each with when it lapses, and resources when its service needs two or more kinds of resource at once. The client by id; their name and contact details only with customers:read. Times also come as timeZone plus start and end When objects, with the offset in force at each instant. A move's asked-for time is requestedStart and requestedEnd, and when it lapses is answerBy, as When objects."},{"name":"accept_booking_request","description":"Accept a booking request: the booking is confirmed or the move carried out, and the client told unless the business's message settings hold it, as Accept on the Requests list. Answered once. Requires a read-write key."},{"name":"decline_booking_request","description":"Decline a booking request, with an optional note for the client: a booking is cancelled as the business (any deposit refunded), a move is dropped. The client's email follows the business's message settings; notifyClient true sends it all the same. Requires a read-write key."},{"name":"send_deposit_link","description":"Send the pay link again for a deposit the business asked for on a booking it made; the link before is closed first, so it can never be paid twice. Requires a read-write key."},{"name":"stop_deposit_request","description":"Stop asking for the deposit on a booking the business made (the client will pay in person): the link stops working. Requires a read-write key."},{"name":"get_checkout","description":"What a booking comes to at checkout, for a point of sale that is not Bookatu's: each line with who did it, price, discount, tax, deposit paid and dueCents; once checked out, the sale that closed it. Only a key made with the checkout:read scope ticked. Read-only."},{"name":"get_visit_availability","description":"The starts a visit of several services fits, one after another, with who does each service and when. Only at a business that lets clients book several services in one visit; two services it keeps apart are refused with the reason. Each slot also has local, its start with the offset in force on its own date on the one timeZone the answer names, and clientLocal on clientTimeZone when that is given. The last service's endAt is when the visit ends. A slot a surcharge covers (a public holiday or a busy time the business charges more for) also has priceCents, surcharges (label, amountType, amount, amountCents) and totalCents, the price at that time, to show the client before they book; other slots have none of these. A from or to that is a date that does not exist, such as 30 February, or one too far away, is refused as Invalid params (-32602) in the words GET /visits/availability uses (\"Use a real date in YYYY-MM-DD format.\", \"Ask for dates in the next few years.\"). Read-only."},{"name":"create_visit","description":"Book a visit of several services as the booking page does: the whole visit or none of it, one confirmation and, where the business approves online bookings, one request. Only at a business that lets clients book several services in one visit. A visit that takes a deposit is refused with DEPOSIT_NEEDS_BOOKING_PAGE and bookingPageUrl (the business's booking page), and nothing is booked. Optional answers ({ questionId: answer }) answers the business's booking questions (list_services lists them on each service), read exactly as answers on POST /book: a required question left out is refused with ANSWERS_REQUIRED and missingQuestionIds, an answer that cannot be read with ANSWERS_INVALID and invalidAnswers, and nothing is booked; ask the person and send their answers, or send them to bookingPageUrl. The answers are never echoed back or sent in a webhook. Each question is asked once for the whole visit. The time is startAt with its offset, or localTime (\"2026-11-04T09:00\") on the business's clock or a named timeZone; a time with no offset is refused with TIME_NEEDS_OFFSET, one the clocks skip with TIME_DOES_NOT_EXIST (and nextValid), one they show twice with TIME_AMBIGUOUS (and both candidates). Requires a read-write key."},{"name":"get_visit","description":"Read a visit of several services: each service in order with its booking, who does it, when, its price and status (and resources, every room, chair or machine it holds, when it needs two or more kinds at once), and the visit's start, end and total. Read-only."},{"name":"reschedule_visit","description":"Move a whole visit to a new start: every service keeps its person and length and is checked again at its new time, so all of them move or none does. The time is startAt with its offset, or localTime (\"2026-11-04T09:00\") on the business's clock or a named timeZone; a time with no offset is refused with TIME_NEEDS_OFFSET, one the clocks skip with TIME_DOES_NOT_EXIST (and nextValid), one they show twice with TIME_AMBIGUOUS (and both candidates). Requires a read-write key."},{"name":"cancel_visit","description":"Cancel every service of a visit still on; the client is told once, and the reply says whether a paid deposit was kept under the business's notice policy (refundDeposit: true refunds it anyway). Requires a read-write key."},{"name":"get_business","description":"The business's time zone, the time there now as a When, its weekly opening hours, the next seven days' openings as When ranges with one-off dates applied, closures (one-off dates in the next 90 days and time the whole business is blocked), its branches with their own zones and hours, and its booking policies. A When is { utc, primary, business: { timeZone, local, utcOffset, abbr, display }, client }, with the offset in force at that instant; quote display rather than converting a time yourself. Read-only."},{"name":"get_walk_in_wait","description":"The business's walk-in wait now, the same answer as GET /walk-in: worked out from its calendar as a walk-in is served, or set by hand by the team. state is no_wait (the earliest start is within 5 minutes: walk in now), wait (5 to 90 minutes away; waitMin is rounded up to 5), busy (more than 90 minutes away; nextAt says when), full_today (open now, nothing fits before closing), closed (closed now; closed.opensAt says when it opens, null when no opening is in the next 14 days) or not_taking (set by hand). status off (with message) while the business has it turned off, and no numbers then. Counts only, never names. Read-only."},{"name":"set_walk_in_wait","description":"Set the walk-in wait by hand (minutes 0 to 240, or notTaking), until it expires (1h, 2h or end_of_day; the business's default when left out), as PUT /walk-in/manual does. Refused as WALK_IN_OFF while turned off. Audited. Requires a read-write key."},{"name":"clear_walk_in_wait","description":"Back to the automatic walk-in wait now, as DELETE /walk-in/manual does; cleared says whether a wait set by hand was in force. Audited. Requires a read-write key."},{"name":"rename_service_category","description":"Rename a service category, or merge it into another: every service in it moves. Answers how many moved. Requires a read-write key."},{"name":"block_time","description":"Block time on the calendar for one team member or the whole business, ending no later than the last day clients can book (a longer block is refused with 422; make it on the calendar). A burst of blocks from one key is refused with 429. Requires a read-write key."},{"name":"add_booking_note","description":"Add to a booking's internal note, never shown to the client. Requires a read-write key."},{"name":"create_customer","description":"Add a client: a name, and an email and phone when given. Never sets marketing consent. Needs customers:manage."},{"name":"update_customer","description":"Change a client's name, email, phone or notes. Never changes marketing consent. Needs customers:manage."},{"name":"add_customer_note","description":"Add to a client's notes. Needs customers:manage."},{"name":"get_client_messages","description":"Which automatic emails and texts the business's clients get: manualOnly (\"Only send client messages when we press Send\") and each message type with its email and text switches, their defaults and where each is kept. Read-only."},{"name":"set_client_messages","description":"Turn automatic client emails and texts on or off: manualOnly, and types by key with email and sms true or false. Unknown or fixed types and channels are refused with fieldErrors. Audited. Sending the same again changes nothing."},{"name":"list_held_client_messages","description":"The client messages the business's switches held back, newest first: key (the switch key PATCH /client-messages takes), type, channel, reason (switched_off or manual_only), when, and the booking and client ids. Never sent later by itself: Send now (POST /client-messages/held/{id}/send) sends one. No addresses or message words. Read-only."},{"name":"send_held_client_message","description":"Send now on one held client message: it goes by its own channel only, as the team's press, with the switches left as they are. A second call answers alreadySent: true and sends nothing more. Refusals use the Settings page's own words, with a reason: 404 not_found when it is not a held message of this business; 409 in_flight while an earlier press is still sending it; 422 too_late, not_sent (no email or number, or messages off for the client; or a text the text service would not take) or texts_off (the business cannot send this text now); 500 send_failed, to try again. Audited."},{"name":"list_held_enquiries","description":"The website enquiries held for the business because the key that sent them could not add enquiries any more (its maker is not on the team, or their role lost the right), newest first: the reason, the key it came with, the person's name, email and phone, the trip, dates, people, message and reference. Each is kept 30 days. Read-only."},{"name":"release_held_enquiry","description":"Move one held website enquiry into Leads, as the website form would have: the same lead and the New enquiry alert, and it is held no more. One whose reference reached Leads since answers duplicate: true and makes no second lead. The person who wrote is not sent anything. Audited."}]},{"id":"commerce","title":"Products and stock","description":"The retail catalog: products, pricing and stock movements, deliveries in and products sold at the point of sale.","tools":[{"name":"list_products","description":"List every retail product in the catalog, active and inactive."},{"name":"create_product","description":"Add a retail product (prices in dollars; optional tracked stock with an opening-stock ledger entry). Requires a read-write key."},{"name":"update_product","description":"Update only the provided fields of a product; a stock change records a ledger adjustment. Requires a read-write key."},{"name":"receive_stock","description":"Record a delivery into a stock-tracked product and log the restock movement. Requires a read-write key."},{"name":"bulk_receive_stock","description":"Receive a whole supplier delivery into stock, 1 to 40 lines, all or nothing. Requires a read-write key."},{"name":"sell_product","description":"Record a product sold in person: its stock drops and the sale counts at its price. Takes no payment. Needs pos:write."}]},{"id":"blog","title":"Blog","description":"The business's public blog: draft, publish, update and unpublish posts.","tools":[{"name":"blog_list_posts","description":"List the business's blog posts (drafts and published), newest first: lean rows without bodies; optional status filter."},{"name":"blog_get_post","description":"Get one blog post in full, markdown body included, by id or slug (drafts visible to the owner)."},{"name":"blog_create_post","description":"Write a blog post (markdown body; slug auto-derived and unique per business). Saves a draft unless publish is true. Requires a read-write key."},{"name":"blog_update_post","description":"Update only the provided fields of a post (the slug never changes) and optionally flip its status via an explicit draft/published field. Requires a read-write key."},{"name":"blog_publish_post","description":"Publish a draft post; the first publish stamps publishedAt and a re-publish keeps the original date. Requires a read-write key."},{"name":"blog_unpublish_post","description":"Take a post off the public blog (back to draft), keeping its content and original publish date. Requires a read-write key."}]},{"id":"forms","title":"Intake and consent forms","description":"Build and manage intake/consent forms and attach them to services. Response listings are summaries only; clients' answers never leave the admin dashboard.","tools":[{"name":"forms_list","description":"List the business's intake / consent forms: lean rows with field, attachment and response counts, never full field schemas; optional active/inactive filter."},{"name":"forms_get","description":"Get one form in full, including its complete field schema and the services it is required before."},{"name":"forms_create","description":"Create an intake / consent form from a hard-validated field schema (the real builder field types; choice fields need 2+ options; bad fields are rejected, never silently dropped). Requires a read-write key."},{"name":"forms_update","description":"Update only the provided parts of a form (a fields array replaces the stored one; active shows/hides it). Service attachment changes go through the attach/detach tools. Requires a read-write key."},{"name":"forms_attach_to_service","description":"Require a form before a service (clients complete it when booking). Both ids must belong to the business; idempotent. Requires a read-write key."},{"name":"forms_detach_from_service","description":"Stop requiring a form before a service. Removes the requirement only; the form and responses stay. Idempotent. Requires a read-write key."},{"name":"forms_list_responses","description":"Summary rows for one form's responses: response id, customer display name and submission time only. Clients' actual answers never leave the admin dashboard (privacy posture)."}]},{"id":"campaigns","title":"Email campaigns (draft only)","description":"Draft email campaigns. There is no send or schedule tool; sending stays an owner action in the dashboard.","tools":[{"name":"campaigns_list","description":"List email campaigns (drafts through sent): lean rows with status, audience segment and counts, never bodies."},{"name":"campaigns_get","description":"Get one campaign in full, body markup included. Audiences are segment names; recipient email addresses are never returned."},{"name":"campaigns_create_draft","description":"Draft an email campaign (subject, composer-markup body, audience segment). Saved as a draft and nothing more: there is no send or schedule tool. Sending stays an owner action in the dashboard. Requires a read-write key."}]},{"id":"storefront","title":"Storefront notices","description":"Post a notice on the storefront's What's on board, live at once. Only a key made with the marketing:write scope ticked.","tools":[{"name":"create_announcement","description":"Post a notice on the storefront's What's on board, live at once. Needs marketing:write."}]},{"id":"reports","title":"Reports","description":"Read-only business performance: period reports, ranked findings and weekly capacity, staff earnings and commission, tips, and deposit reconciliation.","tools":[{"name":"get_report","description":"Business performance for a period vs the period before: revenue, bookings, chair time used, revenue per open hour, rebook and no-show rates, with service/staff/category/channel breakdowns. Read-only."},{"name":"get_findings","description":"Ranked, data-computed findings about the business (severity, headline, detail, suggested action): what the numbers mean, not prose. Read-only."},{"name":"get_capacity","description":"Chair time by day of week and hour in the business's own timezone: where the week is full and where it is empty. Read-only."},{"name":"get_earnings","description":"Staff earnings for a date range: each person's visits and products sold, commission under the business's rules, refunds and voids, and tips, by period and line by line. Read-only."},{"name":"get_tips","description":"Tips for a date range: by person and period, each row of the record, and each tipped sale with its split now. Read-only."},{"name":"get_deposit_report","description":"Deposit reconciliation for a date range: each deposit taken and what became of it (applied at checkout, kept, refunded, held), with Stripe's record beside it. Read-only."}]},{"id":"webhooks","title":"Webhooks","description":"List, register and disable signed webhook endpoints. Signing secrets are shown once and never returned again.","tools":[{"name":"webhooks_list","description":"List the business's webhook endpoints: url, subscribed events, active flag and last delivery status. Signing secrets are never returned."},{"name":"webhooks_create","description":"Register a public https endpoint to receive signed event POSTs; returns the HMAC signing secret once. Unknown event names are rejected. Requires a read-write key."},{"name":"webhooks_disable","description":"Switch an endpoint off: deliveries stop, the endpoint and its history are kept. No delete tool exists; resuming or removing is an owner action in the dashboard. Requires a read-write key."}]},{"id":"classes","title":"Classes","description":"Class sessions and their rosters: who holds a place, adding a phone or walk-in client, taking someone off, and marking who came.","tools":[{"name":"list_class_sessions","description":"List the business's class sessions, soonest first, with capacity, enrolledCount and spotsLeft; by default the scheduled ones still to start. At a business with two or more branches, each session also has locationId: the branch it is held at (its own, else its class's, else the main branch); its start and end are on that branch's clock. Times also come as timeZone plus start and end When objects, with the offset in force at each instant."},{"name":"get_class_roster","description":"Who holds a place on a class session: each place's enrolmentId, the client's id, status (booked, attended, no_show) and how it was paid. Names and contact details only with customers:read. The session's times as in list_class_sessions."},{"name":"add_class_attendee","description":"Put a phone or walk-in client on a class session (matched by email or phone, never opted in to marketing, ticket emailed). A full session stays full. Requires a read-write key."},{"name":"cancel_class_place","description":"Take one person off a class session: the spot is freed, what they paid comes back as account credit, they are emailed. Requires a read-write key."},{"name":"mark_class_attendance","description":"Mark a place attended, no_show, or back to booked. Requires a read-write key."}]},{"id":"audit","title":"Audit log","description":"Who did what in the business, and when. Only a key made with the audit:read scope ticked.","tools":[{"name":"get_audit_log","description":"The audit log, newest first: who did what and when, and what changed; filter by who, what and dates. Only a key made with the audit:read scope ticked. Read-only."}]},{"id":"help","title":"Help and finding things","description":"Any key of the business, with no scope: who the connection is and what it may do, one search across the business, the steps and the exact screen for any task, the help centre, and where an approval has got to.","tools":[{"name":"whoami","description":"The business, the person the credential is held to and their role, its scopes, livemode, and what never goes through an AI. On a key or connected app Bookatu support set up for the business, person has no id and no email, its name says it is Bookatu's platform owner, role is the role it acts with (owner, or the maker's own role once they join the team), and credential.onBehalfOf names the business. Any key of the business, no scope."},{"name":"search","description":"One search across clients, bookings, services, products, the team, the dashboard's pages and the help centre, each kind held to the credential's own scopes; results link into the dashboard. Any key of the business."},{"name":"how_do_i","description":"How to do something in Bookatu: the closest matching admin tasks, each with plain steps, a link to the exact page and card, whether a tool does it, and its help guide. Any key of the business."},{"name":"open_in_bookatu","description":"The link to a dashboard screen, by task, path, section or tool, with why it is done there (never through an AI, or finished by the person on another site). Any key of the business."},{"name":"get_help","description":"The help centre's guides for a question, in the business's language, with their screens, and what an AI never does here. Any key of the business."},{"name":"get_approval","description":"Where a change waiting for a person's approval has got to (pending, approved, declined, used or expired), with the page it is approved on. Needs the approved tool's own scope."}]}],"destructiveTools":true,"notes":"There are deliberately no delete tools; removing data stays a human action in the admin dashboard. Tools that change or cancel something that exists carry destructiveHint, and tools that email a client, call an outside URL or publish to the public web carry openWorldHint. A sandbox (test mode) business also lists the sandboxTools below, never a live business: sandbox_reset wipes the sandbox's made-up data and seeds it again, with its own test key only. Every successful tool result says livemode in structuredContent, and every tool result, a refusal included, in result._meta[\"com.bookatu/livemode\"]. For a client on protocol 2025-03-26 or later, a refusal and arguments a tool cannot read (code INVALID_PARAMS, with fieldErrors) are tool results with isError; other clients get JSON-RPC errors. Every write says idempotentHint: true only on the writes that change nothing more when called again with the same arguments. Add ?toolsets= with family ids (booking, classes, ...) to the endpoint to load only those families, plus the help tools and get_business; it only narrows what the key's scopes allow.","sandboxTools":[{"name":"sandbox_outbox","description":"Test mode only: listed at a sandbox (test) business. Read the sandbox's test outbox: every email, text, WhatsApp message, call and push notification it would have sent to a client or its team, kept and never sent, newest first. The same messages, filters and cursor as GET /api/v1/{slug}/sandbox/outbox: optional channel (email, sms, whatsapp, voice or push), since (an ISO 8601 time), limit (1 to 100, default 50) and cursor (the nextCursor of the page before). Each message has id, channel, kind (such as booking_confirmation or reminder_24h), to, subject, text, html, appointmentId, customerId, createdAt and meta. Use it to check what a client was told after a booking, a change or a cancellation. Needs customers:read.","scope":"customers:read"},{"name":"sandbox_payments","description":"Test mode only: listed at a sandbox (test) business. Read the sandbox's test payments: every simulated payment it made in test mode, newest first, with nothing charged and no money moved. paymentsMode says how its new payments go: simulated, or stripe_test, whose payments are made in Stripe test mode and listed in the business's Finance, not here. kind is checkout (a test checkout: paid, declined, abandoned or open), payment (the payment a paid checkout made: paid, refunded or partly_refunded), card_hold (a card saved for later: card_saved or open), no_show_charge (a no-show or late-cancellation fee charged to a saved test card: paid, declined, refunded or partly_refunded) or refund (refunded). The same payments, filters and cursor as GET /api/v1/{slug}/sandbox/payments: optional kind, since (an ISO 8601 time), limit (1 to 100, default 50) and cursor (the nextCursor of the page before). Each payment has id, kind, outcome, amountCents (null for a card hold), refundedCents, currency, description, appointmentId, belongsTo (the booking or sale it belongs to: type and id), checkoutSessionId, paymentIntentId, createdAt and updatedAt, and never a client's name, email or phone. Use it to check what a test checkout, a refund or a no-show charge did. Needs reports:read.","scope":"reports:read"},{"name":"sandbox_simulate","description":"Test mode only: listed at a sandbox (test) business. Make one event happen now to one of the sandbox's own bookings, through the same code as the real thing: deposit.paid (its open test checkout is paid), payment.failed (the test card is declined and nothing else changes), checkout.expired (the checkout is abandoned and a booking held for its deposit is let go), booking.client_cancelled (the client's own cancellation, under the business's rules), booking.no_show (marked a no-show; a fee the policy sets waits for the owner) or reminders.due (its reminders go out as if their time had come). Takes event and appointmentId (from create_booking or list_appointments). Answers the booking as it is now, the ids of the outbox messages the event kept (read them with sandbox_outbox), the webhook events it sent and what the event reported. A booking of any other business is APPOINTMENT_NOT_FOUND. The same events, refusals and limits as POST /api/v1/{slug}/sandbox/simulate/{event}. Needs bookings:write.","scope":"bookings:write"},{"name":"sandbox_reset","description":"Test mode only: listed at a sandbox (test) business, to its own test key. Wipe the sandbox and fill it with fresh sample data: every booking, client, service and message made since is gone. It keeps its id, slug, test keys, webhook endpoints and connected apps, so this key goes on working. The same reset as POST /api/developer/sandboxes/{id}/reset with the sandbox's test key: only a bk_test_ key of this sandbox with bookings:write, never a connected app. Answers the sandbox: id, slug, name, timezone, currency, createdAt, lastActiveAt, expiresAt, adminUrl, storefrontUrl and apiBaseUrl. Ask the person before you reset.","scope":"bookings:write"}],"sandboxGuide":"https://bookatu.com/en-nz/developers/testing-ai-agents"},"docsMcp":{"endpoint":"https://bookatu.com/api/mcp/docs","protocol":"MCP (JSON-RPC 2.0) over HTTPS POST","auth":"none","readOnly":true,"covers":["help centre","blog","engineering blog","developer docs","plans and prices"],"tools":[{"name":"search_help","description":"Search the Bookatu help centre, the plain-language guides to every feature, in any of its 14 languages. Returns the guides that match, closest first, with their summary, page, markdown copy and the dashboard screen each is set up on."},{"name":"get_help_article","description":"Get one help guide in full by its slug: what the feature is, why it helps and the real steps to use it, in the language asked for, with its page and its dashboard screen."},{"name":"search_blog","description":"Search the Bookatu blog for business owners (a translated post in the language asked for), or the engineering blog with section \"engineering\". Returns the posts that match, closest first, with their excerpt, date, page and markdown copy."},{"name":"get_blog_post","description":"Get one blog or engineering post in full by its slug, as markdown, with its author, dates, tags and page."},{"name":"search_developer_docs","description":"Search the Bookatu developer docs: every REST endpoint, the webhooks and their events, the MCP servers and their tools, and the guides (authentication, CORS, rate limits). Returns the parts that match, closest first, with a short snippet, their place on /developers and the markdown copy."},{"name":"get_plans","description":"Get what Bookatu costs, as the pricing page states it: each plan's monthly price, billed monthly and billed yearly, how many active clients it covers, the commission, the optional add-ons, the length of the trial and the currency. Takes no arguments."}]},"bookingMcp":{"endpoint":"https://bookatu.com/api/mcp/book","serverCard":"https://bookatu.com/api/mcp/book/server-card","protocol":"MCP (JSON-RPC 2.0) over HTTPS POST","auth":"none","summary":"A public Model Context Protocol (MCP) server for people's own AI assistants. An assistant can look up a business on Bookatu from its booking link, check its free times and hold one, and the person confirms by email. Bookatu never takes payment in a chat.","docs":"https://bookatu.com/en-nz/developers#mcp-book","tools":[{"name":"get_business","title":"Business details and policies","description":"Use this when a person wants to book with a business on Bookatu and you need its details first. Give the business as its Bookatu name, a bookatu.com link to it, or its own website address. Returns its city and area (never a street address), its time zone and the time there now, this week's opening hours, its branches, its booking policies and whether a time can be held here. Do not use for searching for a business by place or by what it offers.","annotations":{"title":"Business details and policies","readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"list_services","title":"Services and prices","description":"Use this when you know the business and the person wants to see what it offers. Returns each service's name, description, length and price, any deposit, and how it is booked: bookVia assistant means a time can be held here, and bookVia website means the person books on the business's own page at bookingPageUrl. Filter with query or category, or pick a branch with locationId. Do not use for health or medical treatments: businesses that offer them are not on this server.","annotations":{"title":"Services and prices","readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"check_availability","title":"Open times","description":"Use this when the person has chosen a service and wants to know when it can be done. Returns open times over up to 14 days, each on the business's clock and, when you pass clientTimeZone, on the person's clock too, with the price at that time. A time marked bookVia assistant has a slotId to pass to hold_booking within 30 minutes. Quote times from the display fields as given. Do not use for holding or booking a time: only hold_booking holds one.","annotations":{"title":"Open times","readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"hold_booking","title":"Hold a time and email the client to confirm","description":"Use this when the person has picked a time from check_availability and said yes to its price and the cancellation policy. Holds that time for up to 15 minutes and emails the person, who confirms it with the link in the email or by reading you the 6-digit code from it. Nothing is booked until they confirm. Pass the person's own name and email address, their time zone and an idempotencyKey: a retry with the same key and details returns the same hold. To change a time you already held, release the earlier hold with release_hold first. Do not use for holding a time for someone who has not given you their own email address, or for taking a payment.","annotations":{"title":"Hold a time and email the client to confirm","readOnlyHint":false,"destructiveHint":false,"idempotentHint":true,"openWorldHint":true}},{"name":"confirm_booking","title":"Confirm a held time with the client's code","description":"Use this when the person reads you the 6-digit code from the email hold_booking sent them. Books the held time: the answer is confirmed, or requested when the business looks at new bookings before accepting them, with the booking's reference. If someone else took the time first, it offers up to three other times. A wrong code is refused and says how many tries are left. Do not use for a code the person did not give you themselves, or to try codes.","annotations":{"title":"Confirm a held time with the client's code","readOnlyHint":false,"destructiveHint":false,"idempotentHint":true,"openWorldHint":true}},{"name":"get_booking_status","title":"Booking status","description":"Use this when the person asks whether a held time was confirmed, or where their booking stands now. Pass the holdId hold_booking returned. Returns the status (such as awaiting_client, confirmed, requested, declined, cancelled or moved), the business and service, and the start time. It returns no personal details. Do not use for checking again and again in a loop; ask when the person wants to know.","annotations":{"title":"Booking status","readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}},{"name":"release_hold","title":"Release a held time","description":"Use this when the person no longer wants a time you held for them and has not confirmed it. Ends the hold at once, so the time is free again. Do not use for cancelling a confirmed booking: release_hold only ends a hold that is still waiting, and the person cancels a booking with the business.","annotations":{"title":"Release a held time","readOnlyHint":false,"destructiveHint":true,"idempotentHint":true,"openWorldHint":false}},{"name":"find_businesses","title":"Find businesses","description":"Use this when a person wants to book something on Bookatu and has no business in mind yet. Give the country and at least one of service, name or place (a town, city or area the person named, never their own position). Returns up to 10 businesses that chose to be found here, in name order, each with its city and area (never a street address), the languages it speaks, its lowest price, the services that match and its booking page. No business pays to be listed or placed. Do not use for a business you already know: pass it to get_business.","annotations":{"title":"Find businesses","readOnlyHint":true,"destructiveHint":false,"idempotentHint":true,"openWorldHint":false}}]},"webhooks":{"events":["booking.created","booking.cancelled","booking.completed","booking.rescheduled","order.paid","form.submitted","campaign.sent","booking.checked_out"],"optInEvents":["booking.checked_out"],"signing":"HMAC-SHA256 over \"{timestamp}.{rawBody}\", sent as X-Bookatu-Signature: t={unixSeconds},v1={hex}","privacy":"Payloads carry no customer contact details. Booking events name the client (customerId), who does it (staffId, null when nobody is assigned) and the branch (locationId, null for a business with one address) by id only. Fetch the full record from GET /appointments with your API key when you need more."},"capabilities":{"booking":true,"availability":true,"customers":true,"commerce":true,"inventory":true,"blog":true,"forms":true,"campaigns":"draft-only","webhooks":true,"openapi":true,"checkoutHandoff":true,"bookingRequests":true,"classRosters":true,"moneyReports":true,"auditLog":true,"visits":true,"combinationRules":true,"teamBookings":true,"resourceKinds":true}}