Easy!Appointments

Consume Easy!Appointments API

Actions38

Overview

The Easy!Appointments n8n node, when configured with the Secretary resource and the Get operation, retrieves detailed information about a specific secretary from an Easy!Appointments system via its API. This is useful in automated workflows where you need to fetch secretary details for further processing, reporting, or integration with other systems.

Practical scenarios:

  • Automatically synchronizing secretary data between Easy!Appointments and HR or CRM systems.
  • Fetching secretary details to send notifications or generate reports.
  • Validating secretary existence before assigning tasks or appointments.

Properties

Name Type Meaning
Secretary ID String The unique identifier of the secretary. Required to specify which secretary's details to retrieve.

Output

The output will be a JSON object containing all available details about the specified secretary as returned by the Easy!Appointments API. The exact structure depends on the API response, but typically includes fields such as:

{
  "id": "123",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "1234567890",
  "mobile": "0987654321",
  "address": "123 Main St",
  "city": "Metropolis",
  "state": "State",
  "zip": "12345",
  "notes": "Some notes",
  "timezone": "Europe/Berlin",
  "settings": "{...}",
  "calendarView": "{...}",
  "providers": "1,2,3"
}

Note: The actual fields may vary depending on your Easy!Appointments setup and API version.

Dependencies

  • External Service: Requires access to an Easy!Appointments instance with its API enabled.
  • API Credentials: You must configure the easyAppointmentsApi credential in n8n, including:
    • Base URL (e.g., https://your-easyappointments-instance/api/v1)
    • Username
    • Password

Troubleshooting

Common issues:

  • Missing or incorrect Secretary ID: If the provided Secretary ID does not exist, the node will return an error from the API (e.g., "Not Found").
  • Invalid credentials or base URL: If the API credentials are missing or incorrect, or if the base URL is not set properly, authentication errors will occur.
  • Network/connection errors: If n8n cannot reach the Easy!Appointments server, you'll see connection or timeout errors.

Error messages and resolutions:

  • "Base URL is required": Ensure the Easy!Appointments API URL is correctly set in the credentials.
  • "Not Found" or similar: Double-check the Secretary ID exists in your Easy!Appointments system.
  • Authentication errors: Verify username and password in the n8n credentials.

Links and References

Discussion