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 Appointment resource with the Get Many operation, this node retrieves a list of appointments from your Easy!Appointments system. You can apply various filters such as pagination, sorting, date ranges, and filtering by related entities (service, provider, customer).

Common scenarios:

  • Fetching all upcoming appointments for a specific provider or service.
  • Retrieving paginated lists of appointments for reporting or dashboard purposes.
  • Filtering appointments within a certain date range for analytics.

Practical examples:

  • Get all appointments for a given customer in the next month.
  • List all appointments for a particular service, sorted by date.
  • Retrieve only specific fields (e.g., appointment ID, start time) for lightweight integrations.

Properties

Name Type Meaning
Page Number Page number for paginated results.
Length Number Number of results per page.
Sort String Sort field and direction (e.g., "id asc").
Query String Search query string to filter appointments.
Fields String Comma-separated list of fields to return in each appointment object.
With String Comma-separated list of related data to include (e.g., customer, provider).
Aggregates String Aggregation functions to apply (if supported by the API).
Date String Filter by a specific date (format: YYYY-MM-DD).
From String Start date for filtering appointments (format: YYYY-MM-DD).
Till String End date for filtering appointments (format: YYYY-MM-DD).
Service ID String Filter appointments by a specific service ID.
Provider ID String Filter appointments by a specific provider ID.
Customer ID String Filter appointments by a specific customer ID.

Output

The output is an array of JSON objects, each representing an appointment. The structure of each object depends on the fields requested and the API's response, but typically includes:

{
  "id": 123,
  "start": "2024-07-01 09:00:00",
  "end": "2024-07-01 10:00:00",
  "customerId": 456,
  "providerId": 789,
  "serviceId": 1011,
  "status": "confirmed",
  // ...other fields depending on 'fields' and 'with' parameters
}
  • If the Fields property is used, only those fields will be present.
  • If the With property is used, related data (such as customer or provider details) may be included as nested objects.

Note: This node does not output binary data.

Dependencies

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

Troubleshooting

Common issues:

  • Missing or incorrect credentials: Ensure the API URL, username, and password are correct in your n8n credentials.
  • Base URL is required: If the base URL is missing, the node will throw an error. Double-check your credential setup.
  • Invalid filter values: Supplying invalid dates or IDs may result in empty responses or API errors.
  • Pagination confusion: If you do not set the Page and Length properties, defaults are used (page 1, 10 results per page).

Error messages:

  • "Base URL is required": Set the correct API URL in your credentials.
  • Authentication errors: Check your username/password.
  • API-specific errors: Review the error message returned in the output; it may indicate invalid parameters or server issues.

Links and References

Discussion