Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Easy!Appointments node for n8n allows you to interact with the Easy!Appointments API. Specifically, when using the Category resource and the Get Many operation, this node retrieves a list of categories from your Easy!Appointments system. This is useful for workflows where you need to fetch, filter, or process multiple category records, such as synchronizing categories with another system, generating reports, or populating dropdowns in user interfaces.

Practical examples:

  • Fetch all service categories to display them in a web app.
  • Retrieve paginated lists of categories for reporting or analytics.
  • Search for categories matching a specific query string.

Properties

Name Type Meaning
Filters Collection A set of optional filters to control which categories are returned. The available filter fields are:
Page (Number): Page number of results to retrieve.
Length (Number): Number of results per page.
Sort (String): Sort field and direction (e.g., "id asc").
Query (String): Search query to filter categories by name or description.

Output

The output will be an array of JSON objects, each representing a category. Each object typically contains fields such as:

{
  "id": 1,
  "name": "Consultations",
  "description": "General consultation services"
}

Note: The exact structure may vary depending on your Easy!Appointments API version and configuration, but generally includes at least id, name, and description fields for each category.

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with its API enabled.
  • Credentials: You must configure the easyAppointmentsApi credential in n8n, including:
    • Base URL (without trailing slash)
    • Username
    • Password

Troubleshooting

  • Missing or Incorrect Credentials:
    Error message: "Base URL is required" or authentication errors.
    Resolution: Ensure the Easy!Appointments API credentials are correctly configured in n8n.

  • API Connection Issues:
    Error message: Network or timeout errors.
    Resolution: Check network connectivity and that the Easy!Appointments API endpoint is accessible from your n8n instance.

  • Invalid Filter Values:
    Error message: API returns validation errors.
    Resolution: Double-check that filter values (such as page, length, sort) are valid and within expected ranges.

  • No Results Returned:
    Possible cause: Filters are too restrictive or there are no categories matching the criteria.
    Resolution: Adjust or remove filters to broaden the search.

Links and References

Discussion