SimplyBook.me icon

SimplyBook.me

Consume SimplyBook.me API
Join our community

Actions15

Overview

The node integrates with the SimplyBook.me API to retrieve client data. Specifically, the "Get Clients" operation fetches a paginated list of clients from the SimplyBook.me system. This is useful for scenarios where you want to synchronize client information, generate reports, or trigger workflows based on client data stored in SimplyBook.me.

Practical examples include:

  • Importing client lists into a CRM or marketing tool.
  • Filtering clients by search terms such as name, email, or phone number.
  • Automating follow-ups or notifications based on client details.

Properties

Name Meaning
Page The page number of results to retrieve (pagination). Defaults to 1.
On Page Number of clients to return per page. Defaults to 100.
Clients Filter Optional filter collection to narrow down clients. Currently supports:
- Search Search term to find clients by name, email, or phone number.

Output

The node outputs JSON data representing the list of clients retrieved from SimplyBook.me. Each item in the output corresponds to a client object containing their details as provided by the API.

If binary data were involved (e.g., client profile images), it would be included in a separate binary property, but this operation focuses on JSON client data only.

Dependencies

  • Requires an active SimplyBook.me account and API access.
  • Needs an API key credential configured in n8n to authenticate requests.
  • The base URL for the API is taken from the credentials configuration.

Troubleshooting

  • Common issues:

    • Pagination parameters out of range may result in empty responses.
    • Invalid or missing API credentials will cause authentication errors.
    • Network connectivity problems can lead to request timeouts or failures.

  • Error messages:

    • Authentication errors typically indicate invalid API keys; verify and update credentials.
    • Rate limit errors suggest too many requests in a short period; implement delays or reduce request frequency.
    • Validation errors on input properties mean required fields are missing or incorrectly formatted; ensure "Page" and "On Page" are positive integers.

Links and References

Discussion