Easy!Appointments icon

Easy!Appointments

Interact with Easy!Appointments API

Actions21

Overview

This node interacts with the Easy!Appointments API to manage services and related data. Specifically, the "Service" resource with the "Get Many" operation allows users to retrieve multiple service records from their Easy!Appointments account. This is useful for scenarios where you want to list all available services or filter them based on certain criteria.

Practical examples include:

  • Fetching all services offered by a business to display in a booking system.
  • Retrieving a limited number of services for quick reference or reporting.
  • Applying filters such as search queries or sorting to find specific services efficiently.

Properties

Name Meaning
Return All Whether to return all matching service records or limit the number of results returned.
Limit The maximum number of service records to return (used only if "Return All" is false).
Additional Fields Optional parameters to customize the response:
- Fields Comma-separated list of specific fields to include in the response for each service.
- Include Related Comma-separated list of related data entities to include alongside the services.
- Sort Field name to sort the results by; prefix with "-" for descending order.
- Search Query A search term to filter services by matching text.

Output

The output is a JSON array where each item represents a service record retrieved from Easy!Appointments. Each service object includes properties such as its ID, name, duration, price, and any additional fields requested.

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Easy!Appointments API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the Easy!Appointments instance must be set in the credentials.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Providing invalid field names in the "Fields" property may result in incomplete or empty responses.
    • Using an unsupported sort field can lead to errors or unsorted results.
  • Error messages:
    • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
    • Validation errors may occur if input parameters are malformed; ensure correct formatting, especially for comma-separated lists.
    • Network errors suggest connectivity problems; check your internet connection and API endpoint availability.

Links and References

Discussion