SimplyBook.me icon

SimplyBook.me

Consume SimplyBook.me API
Join our community

Actions15

Overview

This node integrates with the SimplyBook.me API to retrieve booking information. Specifically, the "Get Bookings" operation under the "Booking" resource allows users to fetch bookings within a specified date range, optionally filtered by service, provider, status, and other criteria.

Common scenarios for this node include:

  • Retrieving upcoming or past bookings for reporting or synchronization with other systems.
  • Filtering bookings by status (e.g., confirmed, pending) to manage appointment workflows.
  • Paginating through large sets of bookings to process them in batches.

Practical example:

  • A business wants to pull all confirmed bookings for a particular service between two dates to generate daily schedules.
  • An integration that syncs client bookings from SimplyBook.me into a CRM system, filtering only upcoming bookings.

Properties

Name Meaning
Service Name or ID Select a specific service by name or ID to filter bookings related to that service. Options are dynamically loaded.
Provider Name or ID Select a specific provider by name or ID to filter bookings related to that provider. Options are dynamically loaded.
Date From The start date/time from which to retrieve bookings. This is a required field.
Date To The end date/time until which to retrieve bookings. This is a required field.
Upcoming Bookings Only Boolean flag to restrict results to only upcoming bookings (true) or include past bookings as well (false).
Status Filter bookings by their status. Options include: All, Confirmed, Confirmed Pending, Pending, Canceled. This is a required field.
Page The page number of results to retrieve for pagination. Required.
On Page Number of bookings to retrieve per page. Required.
Calendar Data Filter Additional filters to refine the bookings query:
- Search: Free text search string.
- Client Name or ID: Filter bookings by a specific client. Both options support dynamic expressions and are optional.

Output

The node outputs an array of booking objects in the json field of each item. Each booking object contains details about individual bookings retrieved from SimplyBook.me according to the specified filters.

If binary data were involved (e.g., attachments), it would be included in the binary output, but this operation focuses on JSON booking data only.

Dependencies

  • Requires an active SimplyBook.me account and API access.
  • Needs an API authentication token configured in n8n credentials (referred generically as an API key credential).
  • The base URL for the SimplyBook.me API must be set in the credentials configuration.

Troubleshooting

  • Empty results: Ensure the date range (Date From and Date To) is valid and covers the period where bookings exist.
  • Invalid credentials: Check that the API key credential is correctly configured and has sufficient permissions.
  • Pagination issues: If many bookings exist, verify that Page and On Page parameters are set appropriately to navigate through all results.
  • Filter mismatches: Using incompatible filters (e.g., selecting a provider not linked to the chosen service) may result in no data returned.
  • API rate limits: Excessive requests might trigger rate limiting; consider adding delays or reducing request frequency.

Links and References

Discussion