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 Unavailability resource with the Create operation, this node enables you to create a new unavailability period for a provider. This is useful for marking times when a provider is not available for appointments (e.g., vacations, breaks, or other absences).

Common scenarios:

  • Automatically block out vacation periods for staff.
  • Integrate HR or leave management systems to sync unavailabilities.
  • Prevent double-booking by programmatically setting unavailable slots.

Example:
A clinic wants to ensure that doctors' holidays are reflected in the booking system. Using this node, an automation can add these unavailability periods directly into Easy!Appointments whenever a holiday is approved.


Properties

Name Type Meaning
Start String Start date and time of the unavailability (format: YYYY-MM-DD HH:MM:SS)
End String End date and time of the unavailability (format: YYYY-MM-DD HH:MM:SS)
Location String Location of the unavailability
Notes String Notes for the unavailability
Provider ID String ID of the provider

All these properties are grouped under Additional Fields.


Output

The output will be a JSON object representing the created unavailability as returned by the Easy!Appointments API. The structure typically includes all fields sent in the request, possibly along with additional metadata such as an ID or timestamps, depending on the API's response.

Example output:

{
  "id": 123,
  "start": "2024-07-01 09:00:00",
  "end": "2024-07-01 17:00:00",
  "location": "Main Office",
  "notes": "Annual leave",
  "providerId": "456"
}

Note: Actual fields may vary based on the API implementation.


Dependencies

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

Troubleshooting

Common issues:

  • Missing or invalid credentials: Ensure the easyAppointmentsApi credential is set up correctly in n8n.
  • Base URL is required: If the base URL is missing from credentials, the node will throw an error.
  • Invalid date/time format: Dates must be in YYYY-MM-DD HH:MM:SS format.
  • Provider ID missing: The unavailability cannot be created without specifying a valid provider.

Error messages:

  • "Base URL is required": Check your credentials configuration.
  • Authentication errors: Ensure username/password are correct and have sufficient permissions.
  • Validation errors from API: Review the input data, especially date formats and required fields.

Links and References

Discussion