SimplyBook.me API
SimplyBook.me is a cloud appointment scheduling and online booking platform for beauty, wellness, healthcare, fitness, and other service businesses. Its JSON-RPC API is gated behind the paid API Custom Feature—once enabled, an unofficial integration lets you programmatically pull bookings, clients, services, providers, and availability, and push new bookings, edits, cancellations, and client records back into SimplyBook.me.
What is SimplyBook.me?
SimplyBook.me is a cloud-based appointment scheduling and online booking platform for service businesses. Clients book 24/7 across the company website, Facebook, Instagram, Google, and a branded app, while businesses manage staff availability, automated reminders, payments, and client history from one system. It serves beauty and wellness salons and spas first, alongside healthcare clinics, fitness and sports, education, professional services, and events.
Core capabilities include:
- Multi-channel booking with calendar sync, recurring and group bookings, and an AI voice booking assistant
- Automated email, SMS, WhatsApp, and Telegram notifications, reminders, and review requests
- Payment processing, POS, gift cards, coupons, memberships, and package management
- Custom intake forms (HIPAA and SOAP), client history, product sales, and loyalty tools
Common data entities:
- Bookings, statuses, comments, and recurring settings
- Clients, client comments, and intake form data
- Services (events), service providers (units), durations, and pricing
- Availability, start-time matrices, working hours, and breaks
- Booking stats, revenue, top performers, and workload metrics
The SimplyBook.me Integration Challenge
Service businesses run their day on SimplyBook.me, but turning it into a reliable API-driven integration runs into several obstacles:
- Paid-feature gating: API access only exists once the paid API Custom Feature is enabled in the admin interface, so the integration surface is off by default
- JSON-RPC, not REST: Methods are invoked through JSON-RPC 2.0 envelopes across separate login, public, and admin services rather than conventional REST resources
- Short-lived tokens: Access tokens issued by getToken expire after one hour, requiring continuous re-issuance and rotation for headless automation
- Per-company keys: Each company tenant has its own API key, so multi-location operators must orchestrate credentials and tokens across many tenants
- Method sprawl: Over eighty admin methods span bookings, clients, catalog, availability, and reporting, with their own parameter shapes and ID conventions
- Booking-lifecycle nuance: book, editBook, and cancelBooking must respect availability, working hours, and status rules to avoid double-booking or invalid slots
How Supergood Creates SimplyBook.me APIs
Supergood wraps the SimplyBook.me JSON-RPC services behind a resilient, normalized API layer for your company tenant, handling token exchange, method routing, and lifecycle rules so you integrate once against clean objects.
- Exchanges your API key for access tokens via getToken and refreshes them before the one-hour expiry
- Wraps the JSON-RPC login, public, and admin services so you call normalized endpoints instead of raw RPC envelopes
- Normalizes bookings, clients, services, providers, and availability into consistent objects across companies and locations
- Honors availability, working hours, and status rules when creating, editing, and canceling bookings
Use SimplyBook.me with AI agents: SimplyBook.me MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your company tenants, enabled Custom Features, and authentication model.
- Supergood Generates and Validates Your API
We deliver a production-ready SimplyBook.me adapter tailored to your services, providers, and booking workflows.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adaptation as SimplyBook.me evolves.
API Endpoints
Authentication
/login/getTokenExchange your company login and API key from the API Custom Feature for a one-hour access token used on subsequent JSON-RPC calls.
Bookings
/admin/getBookingsRetrieve a filtered list of bookings by date range, service, provider, client, or status, with details available via getBookingDetails.
Bookings
/admin/bookCreate a new booking for a given service (event), provider (unit), client, and time slot; editBook and cancelBooking manage the lifecycle.
Clients
/admin/getClientListList clients with filters, returning contact and profile data; getClient returns an individual record and addClient creates new ones.
Catalog
/admin/getEventListFetch the catalog of services (events) and service providers (units) configured for the company, including durations and pricing.
Availability
/admin/getStartTimeMatrixReturn available start times and open intervals for a service and provider so external apps can present real-time booking slots.
Use Cases
Sync bookings and clients into your data stack
- Pull bookings, statuses, and revenue from getBookings and getBookingRevenue into a warehouse or BI tool - Stream client records from getClientList into a CRM for marketing and retention - Reconcile services, providers, and pricing from getEventList and getUnitList across locations
Power custom booking experiences
- Surface real-time availability with getStartTimeMatrix and getAvailableTimeIntervals - Create, edit, and cancel appointments through book, editBook, and cancelBooking - Apply company-specific working hours and breaks via getWorkDaysInfo
Automate client communication workflows
- Detect new and changed bookings and trigger downstream SMS, email, or WhatsApp flows - Push appointment data to review-request and loyalty tools - Keep no-show and cancellation events in sync with retention automations
Centralize performance reporting
- Aggregate getBookingStats, getTopPerformers, and getTopServices across multiple companies - Track provider workload and utilization from getWorkload - Feed revenue and visitor metrics into executive dashboards
Technical Specifications
Authentication
Company login plus API key from the paid API Custom Feature, exchanged via getToken for a one-hour access token; user-level tokens for admin methods
Connectivity
JSON-RPC 2.0 over HTTPS against the login, public, and admin services on user-api.simplybook.me
Response format
JSON-RPC result objects normalized into consistent JSON for bookings, clients, services, providers, and availability
Rate limits
Adaptive throttling tuned to the company tenant, with token reuse within the one-hour validity window to avoid re-auth churn
Session management
Automatic token refresh on expiry, credential rotation, and re-login handling for the short-lived access token
Data freshness
Near real-time reads for bookings and availability, with optional scheduled syncs for clients and catalog data
Security
Encrypted credential vault, scoped tokens, and audit logging, aligned with SimplyBook.me's ISO 27001 and GDPR posture
Webhooks
Booking callback URLs (create, change, cancel) normalized into event-style notifications for downstream automation
Latency
Sub-second reads on cached catalog and client data; multi-second writes when creating or editing bookings
Throughput
Horizontally scaled workers sized to multi-location and multi-company booking volume
Reliability
Retry, backoff, and idempotency handling for book, editBook, and cancelBooking operations
Adaptation
Continuous monitoring of SimplyBook.me API method changes and Custom Feature configuration drift
Frequently asked questions
Yes. API access is gated behind the API Custom Feature, which must be enabled in the admin interface under Custom Features. Once active, the API key is available in its settings and Supergood works against your authenticated company tenant.
It is JSON-RPC 2.0 over HTTPS, with separate login, public, and admin services. Supergood handles the JSON-RPC envelope, token exchange, and method routing so you integrate against normalized objects instead of raw RPC calls.
You call getToken with your company login and API key to receive an access token valid for one hour. Supergood manages token issuance, refresh, and rotation automatically so your integration never has to handle expiry manually.
You can read bookings, clients, services (events), providers (units), availability, and reporting metrics, and write new bookings, edits, cancellations, and client records through the admin service methods.
Yes. Each SimplyBook.me company has its own API key and tenant. Supergood normalizes bookings, clients, and catalog data across companies so multi-location operators integrate once across all of them.