APIs
Generators
Stacks
Projects

Docs
History
Schema
Generate

Filter operations

get/api/v1/public/{slug}/servicesList services for a business, with the price range across the team (price_min_minor, price_max_minor)
get/api/v1/public/{slug}/providersList staff and locations
get/api/v1/public/{slug}/availabilitySearch provisional slots
get/api/v1/public/{slug}/capabilitiesBooking features this business supports (multi-service visits, calendar files)
post/api/v1/public/{slug}/bookingsCreate a held booking awaiting deposit (idempotent)
get/api/v1/public/{slug}/bookings/{reference}Read a booking with its manage token
post/api/v1/public/{slug}/bookings/{reference}/depositCreate or return the hosted deposit checkout
get/api/v1/public/{slug}/bookings/{reference}/paymentAuthoritative payment status
post/api/v1/public/{slug}/bookings/{reference}/rescheduleReschedule within policy
post/api/v1/public/{slug}/bookings/{reference}/cancelCancel within policy
get/api/v1/public/{slug}/bookings/{reference}/cancel-previewRead cancellation policy and stored money without mutation
post/api/v1/public/{slug}/messagesLeave a message for the team
post/api/v1/public/{slug}/handoverRequest a human handover
get/api/v1/meCurrent credential, scopes and MCP tools
get/api/v1/servicesList services
post/api/v1/servicesCreate a service
delete/api/v1/services/{id}Delete a service. One with no history is deleted (outcome deleted); one with past bookings or other records is removed from every list and kept on those records (outcome removed). Refused with the upcoming bookings listed, or when another service needs it first
patch/api/v1/services/{id}Update a service
get/api/v1/providersList staff, hours and locations
put/api/v1/providers/{id}/working-hoursReplace weekly hours
post/api/v1/providers/{id}/time-offAdd leave or a block
get/api/v1/availabilitySearch slots
get/api/v1/capabilitiesBooking features this business supports
get/api/v1/bookingsList bookings (from, to as YYYY-MM-DD)
post/api/v1/bookingsCreate a held booking
get/api/v1/bookings/{reference}Read a booking with history
post/api/v1/bookings/{reference}/depositCreate deposit request
get/api/v1/bookings/{reference}/paymentPayment status
post/api/v1/bookings/{reference}/rescheduleReschedule
post/api/v1/bookings/{reference}/cancelCancel
post/api/v1/bookings/{reference}/confirm-without-depositStaff: confirm a booking waiting for its deposit without taking it (paid in the salon). Closes the payment link; the client gets the normal confirmation
post/api/v1/bookings/{reference}/add-serviceStaff: add a service to an appointment as its next segment, by default straight after the last one with the same team member. Past appointments up to 30 days back too. Nothing is sent to the client
post/api/v1/bookings/{reference}/change-clientStaff: move an appointment (every segment of a visit) to another client, for example a relative who shares the phone number. Nothing is sent; the unsent reminder goes to the new client
get/api/v1/bookings/{reference}/cancel-previewRead cancellation preview and saved version without mutation
post/api/v1/bookings/{reference}/outcomeMark completed or no-show
post/api/v1/bookings/{reference}/refundRefund a settled deposit (owner approval)
post/api/v1/bookings/{reference}/adjustMove or resize a booking with a version check (drag and drop)
post/api/v1/bookings/{reference}/approvalApprove or decline a booking that needs staff approval
post/api/v1/bookings/{reference}/manage-linkRotate the customer manage link; the old link stops working
post/api/v1/public/{slug}/bookings/{reference}/manage-linkCustomer: rotate your manage link (needs the current link token)
get/api/v1/calendarCalendar for a date range: bookings, working hours, leave, closures and external busy time (from, to, location_id, staff_ids, resource_ids)
get/api/v1/approvalsBookings waiting for staff approval
post/api/v1/recurring-seriesStaff: create a series every N weeks or monthly, for count times, until a date, or open-ended (neither); each occurrence is held independently and open-ended series are topped up daily
post/api/v1/recurring-series/{id}/cancelCancel the rest of a series (from_reference onwards, or all future occurrences)
get/api/v1/locationsLocations with opening hours
post/api/v1/locationsCreate a location
get/api/v1/resourcesRooms and equipment
post/api/v1/resourcesAdd a room or piece of equipment
get/api/v1/closuresCompany closures (from, to)
post/api/v1/closuresAdd a closure for all locations or one; returns clashing bookings
post/api/v1/messagesCapture a message
post/api/v1/handoverRequest a human handover
get/api/v1/inboxMessages, handovers and staff actions
post/api/v1/inbox/{id}/resolveResolve an inbox item
get/api/v1/reports/summaryOwner report
get/api/v1/notificationsNotification outbox (simulated delivery)
get/api/v1/auditAudit trail
get/api/v1/api-keysList API keys
post/api/v1/api-keysCreate a scoped API key
post/api/v1/api-keys/{id}/revokeRevoke a key
get/api/v1/webhook-endpointsList webhook endpoints and deliveries
post/api/v1/webhook-endpointsAdd a signed webhook endpoint (loopback in sandbox)
post/api/v1/usersAdd a staff or admin user
post/api/v1/tenantsCreate a sandbox business and owner account
post/api/v1/auth/loginStaff sign in (sets an HttpOnly session cookie)
post/api/v1/payments/webhooks/{provider}Signed payment provider events (simpay, stripe_test)
get/api/v1/healthHealth check: 200 while the service and database answer, with job lag, oldest pending job and mail outbox figures; 503 when the database does not answer
get/api/v1/health/deepMonitor check for a degraded service: 200 when database, job lag, stuck jobs and mail outbox age are within limits, otherwise 503. Recent server errors, jobs with no handler and closed businesses with a deletion approval due are reported, not judged. Aggregate counts only
post/api/v1/auth/mfaComplete sign-in with a TOTP or recovery code (after MFA_REQUIRED)
post/api/v1/auth/chooseChoose a business after signing in with an identity that has several memberships
post/api/v1/auth/password/forgotRequest a password reset email (always answers the same way)
post/api/v1/auth/password/resetSet a new password with a reset token; revokes every session
post/api/v1/auth/email/verifyVerify an email address with a verification token
post/api/v1/auth/invitations/previewShow who an invitation is for and which business
post/api/v1/auth/invitations/acceptAccept an invitation: set a password, or link the signed-in account
get/api/v1/auth/providersSign-in methods available
get/api/v1/auth/csrfCSRF token for cookie-authenticated writes
get/api/v1/auth/membershipsBusinesses the signed-in person belongs to
post/api/v1/auth/switchSwitch business (new session for the chosen membership)
get/api/v1/me/securitySecurity overview of the signed-in person
get/api/v1/me/sessionsList my active sessions in this business
post/api/v1/me/sessions/{id}/revokeRevoke one of my sessions
post/api/v1/me/sessions/revoke-othersRevoke all my other sessions, in every business
post/api/v1/me/email/send-verificationSend a verification email
post/api/v1/me/mfa/enrolStart TOTP enrolment (secret shown once; the current password is required when the account has one)
post/api/v1/me/mfa/confirmConfirm TOTP enrolment with a code; returns 10 recovery codes once
post/api/v1/me/mfa/disableTurn off TOTP (password and a current code required)
post/api/v1/me/mfa/recovery-codesReplace recovery codes (password and a current code required)
post/api/v1/me/oidc/google/linkStart linking a Google account to the signed-in person
post/api/v1/me/oidc/google/unlinkUnlink Google (needs a password on the account)
get/api/v1/team/rolesRoles and their capabilities
get/api/v1/team/membersList team members and roles
get/api/v1/team/two-stepThe business two-step sign-in rule and the owners and managers who still need to set it up
put/api/v1/team/two-stepRequire two-step sign-in for owners and managers, or make it optional (signed-in owner with two-step sign-in on)
post/api/v1/team/members/{id}/roleChange a member role (not above your own; owners only for owner)
post/api/v1/team/members/{id}/deactivateDeactivate a member: ends sessions and revokes keys they created
post/api/v1/team/members/{id}/reactivateReactivate a member
get/api/v1/team/invitationsList invitations
post/api/v1/team/invitationsInvite a person by email (single-use link, 7 days)
post/api/v1/team/invitations/{id}/revokeRevoke a pending invitation
post/api/v1/categoriesCreate a category

Changes to Create a category

post/api/v1/categories

Oct 19, 202681704199cd37 Revision changes
- info
  added the new optional request property