Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Unavailability: Get Many operation in the Easy!Appointments n8n node retrieves a list of unavailability records from an Easy!Appointments API instance. This is useful for scenarios where you need to analyze, display, or process periods when providers are unavailable (e.g., vacations, breaks, or other blocked times).

Practical examples:

  • Displaying all unavailable time slots for providers in a calendar view.
  • Synchronizing unavailability data with another scheduling system.
  • Generating reports on provider availability.

Properties

Name Type Meaning
Filters Collection A set of optional filters to refine the search results. See below for filter options.

Filters collection options:

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 results.
Fields String Comma-separated list of fields to return in each record.
With String Comma-separated list of related data to include (e.g., related entities or expanded details).

Output

  • The output is a JSON array containing unavailability records matching the specified filters.
  • Each item in the array represents an unavailability entry, typically including fields such as:
    • id
    • start
    • end
    • providerId
    • location
    • notes
    • ...and any additional fields returned by the API, depending on the fields and with parameters.

Example output:

[
  {
    "id": 123,
    "start": "2024-07-01 09:00:00",
    "end": "2024-07-01 12:00:00",
    "providerId": 45,
    "location": "Main Office",
    "notes": "Doctor's appointment"
  },
  ...
]

Dependencies

  • External Service: Requires access to an Easy!Appointments API instance.
  • API Credentials: You must configure the easyAppointmentsApi credential in n8n, which includes:
    • Base URL (url)
    • Username (username)
    • Password (password)
  • n8n Configuration: No special environment variables required beyond the credential setup.

Troubleshooting

Common issues:

  • Invalid credentials: If the username or password is incorrect, authentication will fail.
  • Missing base URL: If the base URL is not provided in the credentials, the node will throw a "Base URL is required" error.
  • Incorrect filter values: Using invalid field names or formats in filters may result in empty results or API errors.
  • API connectivity: Network issues or incorrect API URLs can cause connection failures.

Error messages:

  • "Base URL is required": Ensure the Easy!Appointments API credential has a valid URL.
  • Authentication errors: Double-check your username and password in the credentials.
  • API-specific errors: Review the error message returned in the output for hints about missing or invalid parameters.

Links and References

Discussion